DX Suite 標準API V2 共通仕様ガイド

本記事では、DX Suite 標準API V2 に共通する仕様について説明します。
個別のAPI仕様については、APIリファレンスをご確認ください。

(1) インターフェース仕様

項目	説明
リクエストホスト	https://{組織固有}.dx-suite.com/wf/api/standard/v2/ URIは各API仕様のURIを参照ください。
プロトコル	HTTPS
レスポンスデータ形式	application/json または text/csv
文字コード	リクエスト・レスポンスともに UTF-8 です。
レスポンスステータスコード	リクエストが成功したら、処理結果に関わらず200 を返信します。処理結果はJSON内のstatus値を確認してください。処理前にエラーが発生した場合は4xx/5xxのステータスコードを返信します。
認証	APIを利用するには、DX Suite の設定 > APIキー設定で発行されたAPIキーが必要です。APIキーはお客様を特定し、課金処理等にも使用されるため、第三者に漏洩しないようご注意ください。APIキーは apikey ヘッダで指定します。
リクエストヘッダ	"x-forward-for"ヘッダが空の場合リクエストに失敗します。

※Windows環境でcurlコマンドをご利用になる場合、ファイル名等にマルチバイト文字(全角文字等)が含まれていると文字コードの影響で正常に処理ができません。

標準APIの実行時にエラーが発生した場合は、以下のJSON形式のレスポンスが返されます。

※エラーコードやメッセージについては「APIについて発生し得るエラーコードの種類を教えてください。」を参照

　エラーレスポンスの例：存在しないIDを指定した場合

{
  "errors": [
    {
     "errorCode": 120001,
     "message": "specified resource does not exist"
    }
  ]
}