共通仕様
接続先
ご契約頂いたドメインが接続先となります。
レスポンス形式
json形式
認証について
管理画面で発行するAPI Keyを利用し認証を行います。API Keyはリクエストヘッダ(Authorization)に付加頂きます。
HTTPリクエストヘッダ
| ヘッダ名 | 型 | 必須 | 値 |
|---|---|---|---|
| Authorization | 文字列 | 〇 | 管理画面で発行されたAPI Key |
エラーレスポンス
エラーが発生した場合は、エラーコードとエラーメッセージがそれぞれレスポンスヘッダ、レスポンスボディにセットされます。
サンプル：認証が失敗した場合
レスポンスヘッダ
- HTTP/1.1 401 Unauthorized
Content-Type: application/json; charset=utf-8
Content-Language: ja
レスポンスボディ
- {
- "title" :"認証エラー",
- "detail" :"認証キーを確認してください"
- }
エラーコード一覧
| コード | 内容 |
|---|---|
| 400 | パラメータにデータ形式などの誤りがあります。（登録系APIの場合はURLで指定した id が存在しない場合を含みます） |
| 401 | 認証情報に誤りがある、もしくはAuthorizationヘッダがありません。 |
| 403 | アクセス権限がありません。 |
| 404 | リクエスト先が存在しません。 |
| 415 | リクエストヘッダの「Content-Type」は「application/json」を設定してください。 |
| 429 | 分間の最大リクエスト数の制限を超えています。(レート制限) |
| 500 | サーバーエラーが発生しています。 |
| 501 | 指定したリクエストメソッドには対応していません。 |
| 503 | 一時的にサービスを停止しています。(メンテナンス等) |