共通仕様

■ 共通リクエストヘッダ

APIコールする際は、リクエストヘッダへAPIアクセスキーを設定する必要があります。
APIアクセスキーは、ログインAPIにて認証を行うことで取得できます。
APIアクセスキーが正しくセットされていない場合は、[400 Bad Request]を返します。

リクエストヘッダ	説明
x-access-key	APIアクセスキー
content-type	application/json

■ 共通レスポンス

JSON形式で返却します。

項目	説明
code	API処理結果 0:成功 1:不正なデータ(入力チェックエラー) 97:不正なリクエスト 98:APIアクセスキーエラー 99:サーバーエラー
data	成功時に処理結果データを格納
message	オプション エラー時のメッセージなど
error_fields	オプション 入力チェックエラー時の項目とエラーメッセージのリスト 例） [{'field':'email', 'message':'正しいメール形式ではありません'}]

※ 以下のAPI仕様書には、特に指定が無い場合は、data項目以下のみの定義を記述しています。