アクセストークンの設定
発行したアクセストークンを、APIリクエストで利用します。
アクセストークンの発行方法は、「アクセストークンの発行」をご確認ください。
リクエスト
アクセストークンはAPIリクエスト時、ヘッダに設定します。
ヘッダ設定
設定されたアクセストークンから、認証をおこないます。
項目 | 設定値 |
Authorization | Bearer[SP]{発行済みのアクセストークン} ※[SP]は半角スペース |
レスポンス
ステータスコード
コード | メッセージ | 説明 |
401 | Unauthorized | アクセストークンが未設定。 |
403 | Forbidden | 認可されていない。アクセストークンの有効期限切れなど。 |
認証に成功した場合は、各APIの処理結果により、ステータスコードが返却されます。
上記以外のステータスコードが返却される場合もあります。 その場合は、RFC2616規定のHTTPレスポンスステータスコード一覧をご確認ください。
サンプル
ここでは配信予約キャンセルを例として記載しています。
リクエスト
DELETE https://xxxxxxxxxxxxx/send/xxxxxxxxxxxxx& Authorization=Bearer XXXXXXXXXXXXX
※ヘッダ情報含む
レスポンス
リクエストデータにより、サンプルに記載の項目以外の情報も返却される可能性があります。
正常
HTTP/1.1 200 OK Content-Type: application/json { "items": [ { "delivery_id": "xxxxxxxxxxxxxxx" } ] }
※ヘッダ情報含む
成功した場合は、リクエストした内容に基づいて返却が行われます。
エラー
HTTP/1.1 401 Unauthorized Content-Type: application/json { "message":"Unauthorized" }
※ヘッダ情報含む
失敗した場合は、補足情報が返却されます。