Skip to main content

REST API認証とヘッダー

Varicent Incentivesへの各APIの呼び出しでは、APIキーを含むリクエストヘッダーを設定する必要があります。

REST API呼び出しは、APIキーを介して認証されます。Varicent IncentivesでAPIキーを取得するには：

  1. 管理者クライアントツールバーで、ユーザー・オプションアイコンUser iconをクリックし、[ユーザー・オプション] をクリックします。

  2. [APIキーの作成]をクリックし、APIキーをメモします。

    注記

    APIキーは一度しか表示されないため、安全な場所に保管してください。

各APIの呼び出しでは、APIキーを含む次の3つのリクエストヘッダーを設定する必要があります。

表89 REST APIヘッダー

リクエストヘッダー

説明

Authorization

Bearer API キーに設定します。

たとえば、Authorization: Bearer APIキー

Model

アクションを実行するモデルに設定します。

Content-Type

application/jsonに設定します。



Varicent IncentivesREST APIには、C#やPythonなどのネットワーク対応言語から、またはPostmanやCurlなどのツールを使用してアクセスできます。