Authentication

APIキー

APIリクエストを認証するには、リクエストヘッダーにAPIキーを含めてください。

API-KEY: your_api_key

APIキーは、Alliダッシュボードのプロジェクト設定>全般で確認できます。

ユーザー識別

ユーザーID

ユーザーを指定するには、OWN-USER-IDヘッダーにユーザーIDを含めてください。これには以下のいずれかが含まれます:

  • 既存のユーザーID - 以前に作成されたユーザーを識別します

  • 新しいユーザーID - Alliが自動的にこのIDで新しいユーザーを作成します

同じOWN-USER-IDを使用した今後のAPI呼び出しは、同じユーザーからのものとして扱われます。

メール情報

ユーザーにメールアドレスを関連付けるには、USER-EMAILをヘッダーに含めてください。

非ASCII文字の制限

OWN-USER-IDには非ASCII文字を含めることはできません。ユーザーIDに非ASCII文字が含まれる場合は、base64にエンコードし、次の形式を使用してください。:

OWN-USER-ID: base64:CONVERTED_ID

ユーザーIDとメール情報は、Alliダッシュボードのユーザーメニューで確認できます。

ヘッダーの例

OWN-USER-ID: 5f1234567a409876c082487
USER-EMAIL: [email protected]

エージェント情報

特定のエージェントの情報を使用してAPI呼び出しを行うには、AGENT-EMAILヘッダーにエージェントのメールアドレスを含めてください。

ログイン中のエージェントのメールアドレスをAGENT-EMAILとしてヘッダーに含めると、そのエージェントの情報がAPI呼び出しに使用されます。

ヘッダーの例

AGENT-EMAIL: [email protected]

Last updated

Was this helpful?