APIクライアントとAPIキー ​

クライアントは、1つ以上のAPIコレクションへのアクセス権を受け取る、同じ組織のメンバーなどのユーザーの論理グループです。 クライアントは、リクエストを認証し、APIコレクションへのアクセスを管理し、セキュリティパラメーターを定義するためのAPIキーを生成できます。

APIクライアント ​

既存のクライアントを管理し、新しいクライアントを追加するには、プラットフォーム > API platform > クライアントに移動します。

API platformのクライアントタブ

新しいAPIクライアントの作成 ​

新しいクライアントを追加して設定するには、次の手順を実行します:

ポータルアクセスが有効になっている場合、Workatoはクライアントのメールアドレスに招待メールを送信します。 APIコレクションや認証方法へのアクセスなどの権限は、クライアントレベルで設定されます。

クライアントの作成

クライアントを追加した後、あなたまたはクライアントはAPIキーを作成してAPIリクエストを認証し、割り当てられたコレクションへのアクセスを管理できます。

APIキー ​

APIキータブでは、アクセストークンを作成および管理できます。 セキュリティを強化するために任意のIP制限付きで新しいキーを生成したり、既存のキーを管理、更新、または必要に応じて無効化したりできます。

APIキーの管理

APIキーは安全な認証を提供します。 APIキーにより、厳格なアクセス制御を維持しながら、クライアントは割り当てられたAPIコレクションにアクセスできます。

新しいAPIキーの作成 ​

新しいAPIキーを作成するには、次の手順を完了します。

アクセスプロファイル ​

すべてのクライアントには、APIコレクションに関連付けられた1つ以上のアクセスプロファイルがあります。 アクセスプロファイルは、クライアントに1つ以上のAPIレシピコレクションおよびAPIプロキシコレクションへのアクセス権を付与します。

APIオーナーは、APIコンシューマーごとに一意のアクセスプロファイルを作成することをお勧めします。 これにより、APIオーナーとして特定のAPIコレクションへのアクセスを委任し、アクセスポリシーを適用できます。 さらに、APIコンシューマーがAPIエンドポイントをどのように使用しているかに関する利用状況情報を生成できます。

クライアントのアクセスプロファイルを表示し、新しいプロファイルを作成するには、API platform > クライアントに移動してクライアントを選択します。 次のスクリーンショットは、1つのアクセスプロファイル（同じくACME Companyという名前）を持つクライアント（ACME Company）の例を示しています。

アクセスプロファイルを持つAPIクライアント

アクセスプロファイルのフィールド ​

各クライアントの一意のAPIキーは、認証トークンフィールドに生成されます。 このトークンは長い文字列です。 クライアントがAPIに接続できるようにするには、クライアントにこのトークンを提供する必要があります。 このAPIキーは機密情報として扱ってください。APIオーナーとクライアントのみが知っている必要があります。

トークンの横にある更新ボタンをクリックすると、APIキーを取り消して新しいキーを発行できます。

クライアントはアクティブまたは非アクティブにできます。 非アクティブなクライアントはAPIを呼び出せません。 トグルをクリックしてクライアントのステータスをアクティブに設定し、クライアントがAPIを呼び出せるようにします。

新しいアクセスプロファイルの作成 ​

前提条件:

1. APIコレクションを設定
2. 任意 アクセスポリシーを作成
3. クライアントを作成