標準的な2-legged OAuth2によりリクエストは認証されます: エンコードされたAPI Key を使用して access_token
を要求し、取得した access_token
がそれ以降のリクエストの認証に使用されます。
APIキーは、LTVダッシュボードで確認できます。アプリを選択 -> 設定 -> アプリ設定 -> 下にスクロール -> APIキーをご覧ください。
アクセストークンの有効期間は一時間で、リフレッシュはできません。トークンの有効期限が切れた場合には、 Publisher Reporting API Key/Marketing API Key を使用して新しいトークンを取得してください。
アクセストークンをリクエストするには、APIキーを使ってAuthorizationヘッダー付きのPOSTリクエストを送信する必要があります。認証情報が正しければ、アクセストークンとその有効期限(秒単位)が含まれたレスポンスが返ります。
リクエスト例
POST /v1/oauth2/token
Host: api.tapjoy.com
Authorization: Basic <API Key>
Accept: application/json
認証成功時のレスポンス例
status 200
{
“access_token”: “token_string”,
“token_type”: “bearer”,
“expires_in”: 3600,
“refresh_token”: null
}
認証失敗時のレスポンス例
status 401
{
“error”: “Unauthorized”
}
access_token
を取得すれば、目的のAPIへのリクエストができるようになります。 access_token
はAPIリクエストのすべての Authorization ヘッダに "Bearer" タイプとして含める必要があります。 access_token
の有効期限が切れていた場合やヘッダが含まれなかった場合、レスポンスのステータスは 401 Unauthorized となります。
リクエスト例
POST /v4/audiences
Host: api.tapjoy.com
Authorization: Bearer <token_string>
Accept: application/json
トークンがない/無効な場合のレスポンス例
status 401
{
“error”: “Unauthorized”
}