認証

Partner API にアクセスするには、API シークレットキーによる認証が必要です。キーは Partner Console で生成、管理します。

API キーは、パートナーリソースにアクセスするための資格情報です。各キーは特定の組織データへのアクセスに制限されており、必要に応じて即座に無効化できます。

API キーはアカウントへの完全なアクセスを提供するため、慎重に取り扱ってください。 公開リポジトリ、クライアントサイドのアプリケーション、その他漏洩のおそれがある場所でこれらのキーを公開しないでください。

リクエストは HTTP Basic 認証で認証し、API キーをユーザー名として渡します。パスワードは空欄のままにします。

API は安全な HTTPS 接続のみを受け付けます。 プレーンな HTTP リクエストは拒否され、適切な認証資格情報がないリクエストも拒否されます。

リクエストの例

curl https://partner-api.performancehub.co/partner/v1/organisations \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# The colon prevents curl from asking for a password.

シークレットキーの確認

curl https://partner-api.performancehub.co/partner/v1/auth/ping \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# Returns { "message": "You are successfully authorised as <PartnerName>" }