1.POST MANとは？

POST MANとは？

Postmanは、1,500万人以上の開発者が利用するツールでAPIを構築および使用するためのAPIプラットフォームです。Postmanは、APIライフサイクルの各ステップを簡素化し、コラボレーションを合理化するため、より優れたAPIをより迅速に作成できます。

POST MANでBカートAPIを利用し、受注データを取得するイメージ図

POST MANでできること

数秒で起動して実行

BカートAPIのコレクションをポストマンにインポートするとワンクリックでリクエストの送信が可能になります。複雑なコーディングは不要です。

リクエストの送信

ポストマンでGetやPostなどあらゆるタイプのリクエスト送信が可能です。またURIパラメータを指定したカスタムリクエストも送信可能です。

レスポンスの確認

リクエストを送信したら即時にステータスコード、応答時間、応答サイズなどのレスポンス確認が可能です。

2.POST MANの初期設定

初期設定の流れについて

初期設定は3つのステップで完了します。まずはBカートAPIのトークンを発行します。次にPOSTMANのアカウントを作成し、ログイン後発行したトークンをPOSTMANに設定します。※Bカートの管理画面で、APIアカウントの発行が可能になっています。詳細はBカートAPIトークン 発行手順こちらの資料でご確認ください。

POST MANアカウントの作成

まずはBカートAPIドキュメントページにアクセスします。ページ右上の「Run in Postman」をクリックします。

続いてポップアップが出てくるので、「Postman for Web」をクリックします。(Windows環境の場合は、デスクトップアプリをダウンロードして利用することも可能です。)

続いて、POST MANのログイン画面に移動します。右上の「Create Account」からアカウントを作成し、ログインをすすめます。

APIトークンの設定

BカートAPI管理画面で作成した、トークンをPOST MANに設定していきます。POSTMANにログインできたら右上の「環境設定」ボタン(目のようなマーク)をクリックします。その後、ポップアップが立ち上がるので「Add」ボタンをクリックします。

続いてトークンとapi_urlを設定していきます。下記の画像に沿って設定を行います。(access_tokenはご自身で発行したものをご利用してください)

これで初期設定は完了です！続いては、実際にPOSTMANを使ってBカートAPIを動かしてみましょう。

3.リクエストとレスポンスを確認してみる

受注情報を取得(GET)をリクエスト

まずはBカートの受注情報をAPIで取得するリクエストを行い、レスポンスを確認していきます。メニュー左から「Collection」を選択すると各エンドポイントが表示されるので「受注」「GET orders」を選択します。

右上に表示される「Send」をクリックすると、リクエストが送信され、ページ下部でレスポンスを確認することができます。

例　受注番号 128番の受注を取得するリクエストとレスポンス

新規商品情報の登録(POST)をリクエスト

次にBカートへAPI使って新規商品を登録するリクエストを行い、レスポンスを確認していきます。メニュー左から「Collection」を選択すると各エンドポイントが表示されるので「商品基本」「POST products」を選択します。また画面中央上部に表示される「body」を選択すると登録する商品データの確認や変更が可能です。

最後に右上に表示される「Send」をクリックすると、サンプルで登録してある商品情報(イームズ風クラシックソファー)リクエストが送信され、ページ下部でレスポンスを確認することができます。

例　商品基本情報をPOSTする

APIで商品情報の登録が成功したら、Bカートの管理画面で商品登録ができているか確認してみましょう。

管理画面＞商品一覧 画面で登録した商品情報の確認が可能です。

4.URIパラメーター(クエリ)を指定してみる

URIパラメーターとは？

受注一覧取得(GET orders)や会員一覧取得(GET customers)など一覧取得のリクエストではURIにパラメータをつけることで、レスポンスを絞り込むことが出来ます。共通のパラメーターは下記の通りです。

パラメータを利用したデータの取得例

最新の100件分(limit)の受注データを取得

{{api_url}}/api/v1/orders?limit=100

Bカート会員ID 10001以降の会員データを30件取得 (&をつけることで複数のパラメータを利用できます)

{{api_url}}/api/v1/customers?offset=10001&limit=30

各エンドポイントごとに利用できるパラメータ

各エンドポイントごとに利用できるパラメータは異なります。例えば、受注情報一覧取得の場合、受注情報内の「発送状況」や「対応状況」をパラメータとして絞り込みに利用できます。

詳細については各ドキュメントにあるURIパラメータを参照してください。

受注データの中から、発送状況＝「発送済」かつ対応状況＝「完了」の受注を絞り込んで取得する

{{api_url}}/api/v1/orders?=logistics_status=発送済&status=完了

拡張URIパラメーターとは？

拡張パラメータを使うことで、より高度な絞り込みが可能になります。
※ 商品基本、商品セット、会員、受注商品、受注におけるカスタム項目にはお使いいただけません。

拡張パラメータを利用して受注データを取得する例:対応状況＝完了、かつしている2019年5月1日～6月1日までの受注情報を取得

https://https://api.bcart.jp/api/v1/orders?status=完了&ordered_at__gte=2019-05-01 00:00:00&&ordered_at__lte=2019-06-01 00:00:00