b→dash APIの共通仕様を知りたい

b→dash APIの共通仕様とは

b→dash APIの共通仕様とは、全てのb→dash APIを開発・導入・利用する上で共通して適用される注意事項です。本記事では「接続方式」「非機能要件」「リクエスト共通仕様」「ステータスコード共通仕様」「エラー発生時のレスポンス」の5項目について記載しています。

各b→dash APIの共通の仕様に関してまとめていますので、それぞれの記事に記載のない仕様については本記事をご参照ください。

接続方式

貴社の基幹システム/アプリケーションにb→dash APIを開発する際は、下記の接続方式をご参照ください。

非機能要件

全てのb→dash APIは下記の非機能要件を持ちます。

リクエスト共通仕様

全てのb→dash APIは下記の形式でリクエストしてください。

〇リクエストメソッド

〇リクエストヘッダ

ステータスコード共通仕様

b→dash APIのリクエストに対するレスポンスは、下記のステータスコードが記載されてます。

〇情報レスポンス(100番台)

〇成功レスポンス(200番台)

〇クライアントエラーレスポンス(400番台)

〇サーバーエラーレスポンス(500番台)

エラー発生時のレスポンス

b→dash APIのリクエストに対するエラー発生時のレスポンスは、下記のステータスコードが記載されてます。

〇レスポンスボディパラメータ

〇レスポンスボディサンプル

{ 
  "result": { 
    "code": 400, 
      "errors": [ 
      { 
      "messsage": "Account not found." 
      } 
    ] 
  } 
} 

〇エラーメッセージ