【2024年最新】BtoB EC市場規模が465兆円を記録した理由とは?@経済産業省
この記事ではBカートAPIドキュメントの活用方法についてご紹介します。
1.基本的な仕様について
最初に確認すること
BカートAPIドキュメントの上部に、基本的なAPIの仕様についての解説をご用意しております。APIの利用回数制限、リクエスト、パラメータ、レスポンスの仕様について確認していきましょう。
利用制限について
BカートAPIは300秒につき300回までリクエストすることが可能です。 300秒に300回を越えると300秒間のロックがかかりアクセスできなくなります。 またリクエスト上限を超えた場合のみ、レスポンスヘッダーに「Retry-After」というカスタムヘッダーが追加され、解除までの時間を取得することも可能です。
2.各エンドポイント
レスポンス一覧
各エンドポイントごとにリクエストした際のレスポンスの一覧を掲載しています。こちらを利用して、どのようなデータが取得できるか?(名称、型、最大桁、内容)を確認することができます。
参考 : BカートAPI 商品セットレスポンス一覧
URIパラメータ一覧
各エンドポイントごとに利用可能なURIパラメータの一覧を掲載しています。こちらを利用して、様々な条件で情報の取得が可能になります。
サンプルコードの確認
Example Request(リクエストのサンプルコード)とExample Response(レスポンスのサンプルコード)を各エンドポイント毎に確認することができます。
開発言語の切り替え
メニュー上部より、開発言語の切り替えを行うことが可能です。言語を変更すると、Example RequestとExample Responseの内容も変更されます。
表示形式の切り替え
メニュー上部より、表示形式の切り替えを行うことが可能です。Single columnとDouble columnから選択することができます。
APIドキュメントの活用方法について読んでいただきありがとうございました。