Product UpdatesStatus PageAutomation Institute
日本語
API プラットフォーム

# API クライアント、アクセスプロファイル、アクセスポリシー

クライアントとは、同じ組織にいる複数のメンバーなどといった、ユーザーの論理グループです。アクセスプロファイルを通じて、1つ以上の API コレクションにアクセスできます。1つのクライアントは1つ以上のアクセスプロファイルを持つことができます。アクセスプロファイルには、コレクション、認証方法、アクセスポリシー、および許可リストに登録された IP アドレスが記載されています。 アクセスポリシーでは、レート制限や使用量の割り当てを通して、API の利用に対する制限が設定されます。

# API クライアント

[Tools] > [API platform] > [Clients] に移動します。ここでは、API の所有者が API クライアントの管理や新規作成を行えます。

[API platform] > [Clients] タブ [API platform] > [Clients] タブ

# 新規クライアントの作成

  1. [Add New Client] をクリックします。
    [Create New Client] ウィンドウが表示されます。 API クライアントの作成 API クライアントの作成
  2. 以下の項目を入力します。
    • Name : クライアントにわかりやすい名前を付けます。
    • (任意) Description : クライアントに関する簡単な説明を入力します。
    • (任意) Client logo : .jpg ファイルまたは .png ファイルを選択して、ロゴをアップロードします。
  3. [Add client] をクリックします。

次に、アクセスプロファイルを作成します。

# アクセスプロファイル

どのクライアントも、API コレクションに関連付けられている1つ以上のアクセスプロファイルを持っています。API 所有者には、API 利用者それぞれに固有のアクセスプロファイルを作成するようお勧めします。それを実行することで、API 所有者は特定の API コレクションへのアクセス権を委譲するとともに、アクセスポリシーを適用することができます。さらに、API 利用者が API エンドポイントをどのように使用しているかという使用状況情報も生成できるようになります。

注 : API 利用者には、ユーザーのほかにも、スクリプトや自動化されたプログラムが含まれます。

クライアントのアクセスプロファイルを表示したり作成したりするには、 [Tools] > [API platform] > [Clients] に移動して、クライアントを選択します。以下のスクリーンショットには、1つのアクセスプロファイル (Howard Brown のアクセスプロファイル) を持つクライアント (Howard Brown) の例が表示されています。

API クライアントとアクセスプロファイル API クライアントとアクセスプロファイル

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

[API key] フィールドに注目してください。クライアントごとに一意の API キーが生成されます。このトークンは、長い文字列です。クライアントが API に接続できるようにするには、このトークンをクライアントに提供する必要があります。この API キーは機密情報として扱ってください。API キーを知っているのは、API の所有者とクライアントのみでなければなりません。

トークンの横の [Refresh] ボタンをクリックすると、API キーを失効させ、新しいキーを発行できます。

クライアントは 無効化 することも 有効化 することもできます。無効化されたクライアントは API を呼び出すことができません。スライダーを右に移動させると、クライアントのステータスが [Enabled] に変更され、API 呼び出しが受け付けられるようになります。

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

準備として行うこと

クライアントの作成が済んだら、そのクライアントを選択し、クライアントのページを開きます。

  1. [Create access profile] をクリックします。
    [Create access profile] ウィンドウが表示されます。 アクセスプロファイルの作成 [Create Access Profile] ウィンドウ
  2. 以下の項目を入力します。
    • Name : アクセスポリシーにわかりやすい名前を付けます。
    • API collections : 1つ以上の API コレクションを選択してクライアントにアクセスを許可し、 [OK] をクリックします。
    • Authentication method : これには、Auth トークンまたは JSON Web Token (JWT) を指定できます。
      JWT を選択した場合 :
      • Signing method: JWT の署名方法を定義します。これには HMAC (共有) または RSA (公開鍵) を指定できます。
      • JWT secret/key: 署名値またはキーです。
    • (任意) Policy: レートや使用量の制限です。
    • (任意) IP Allowlist: 許可リストに追加される1つ以上の IP アドレスです。これが設定されると、これらのアドレスから発生したリクエストのみが許可され、ほかのすべてのアクセスは拒否されます。
  3. [Add profile] をクリックします。

新しいアクセスプロファイルがクライアントのページに表示されます。

← Raw コンテンツ処理
アクセスポリシー →


Last updated: 2023/8/31 1:07:14

On this page