BカートAPIドキュメントの活用方法

2021月10月27日
BカートAPIドキュメントの活用方法

この記事ではBカートAPIドキュメントの活用方法についてご紹介します。

1.基本的な仕様について

最初に確認すること

BカートAPIドキュメントの上部に、基本的なAPIの仕様についての解説をご用意しております。APIの利用回数制限、リクエストパラメータレスポンスの仕様について確認していきましょう。

api_docu_top

利用制限について

BカートAPIは300秒につき300回までリクエストすることが可能です。 300秒に300回を越えると300秒間のロックがかかりアクセスできなくなります。 またリクエスト上限を超えた場合のみ、レスポンスヘッダーに「Retry-After」というカスタムヘッダーが追加され、解除までの時間を取得することも可能です。

 

2.各エンドポイント

レスポンス一覧

各エンドポイントごとにリクエストした際のレスポンスの一覧を掲載しています。こちらを利用して、どのようなデータが取得できるか?(名称、型、最大桁、内容)を確認することができます。

 参考 : BカートAPI 商品セットレスポンス一覧

response_all-min

 

URIパラメータ一覧

各エンドポイントごとに利用可能なURIパラメータの一覧を掲載しています。こちらを利用して、様々な条件で情報の取得が可能になります。

参考  : BカートAPI 商品セット情報 URIパラメータ

uri-min

 

サンプルコードの確認

Example Request(リクエストのサンプルコード)とExample Response(レスポンスのサンプルコード)を各エンドポイント毎に確認することができます。

sample-min

 

開発言語の切り替え

メニュー上部より、開発言語の切り替えを行うことが可能です。言語を変更すると、Example RequestとExample Responseの内容も変更されます。 

api_docu_lang2

 

表示形式の切り替え

メニュー上部より、表示形式の切り替えを行うことが可能です。Single columnとDouble columnから選択することができます。

api_docu_view2

APIドキュメントの活用方法について読んでいただきありがとうございました。

著者について
Bカート運営部
Bカート運営部 Bcart Operations Department

BtoBならBカート!で、おなじみのBカート運営部です。BtoB(企業間取引)のEC化を促進し社会にインパクト与えます。より良いサービスをご提供できるようスタッフ一同奮闘中!

Bカート ブログ

EC業界の最新ニュースやBカートの運営方法、マーケティング手法などをご紹介。Bカートブログを購読して最新の記事情報をメールで受け取りましょう。

いつでも購読を解除することができます