Dash ReplenishmentサービスAPI
I:DRSの実装
APIエンドポイント
DRSは、２つのベースURLをサポートしており、このURLで全てのDRS API エンドポイントを実行可能です。他に、LwAアクセストークンを取得するURLもあります。
APIリクエスト認証
DRSにアクセスするために、ステップ3で、DRS APIへのアクセス権を付与するLogin with Amazonアクセストークンを取得します。この後、お客様がDRSの消耗品再注文の選択フローが完了すると、DRS APIにアクセスするためのトークンを受け取ります。
DRS APIのためのアクセストークンの取得には、次の２つの方法があります：
- Webサイトまたはハイブリッドアプリ向けのLwA Web APIを使用する方法
- iOSおよびAndroidアプリ向けのLwAモバイルSDKを使用する方法
これらの方法で返されるauthorizationCodeを使用してLwAエンドポイントにアクセスし、アクセストークンを受け取ります。
サービス呼び出し
消耗品の再発注や、スロットステータスの報告のようなデバイスに関するAPIコールは、下記のベースURLを用います。
https://dash-replenishment-service-na.amazon.com
エンドポイントの完全な一覧は、下記リストを参照してください。
Web関連の呼び出し
Webに関連したすべての呼び出しには、次のベースURLを使用する必要があります。ユーザー向けのページおよびインタラクション（設定ページ、ティザーページなど）には、このURLを使用してください。
https://drs-web.amazon.com
APIのバージョン管理
Amazonでは、APIを既存のお客様へのインパクトなしにアップデートするために、APIにバージョン付けをしています。すべてのAPIコールには、HTTPヘッダーにx-amzn-type-versionとx-amzn-accept-typeを渡さなければなりません。
x-amzn-type-version– リクエストのバージョンコントロール用x-amzn-accept-type– レスポンスのバージョンコントロール用
サポートするバージョンは、各々のDRS APIエンドポイントで定義されています。
バージョンと後方互換
特定のAPIエンドポイントが複数のバージョンをサポートしている場合、各々のバージョンにおけるシンタックスは、説明ページの対応するタブをご覧ください。DRSは後方互換であり、いつでも古いバージョンを利用することが可能です。
エンドポイントの一覧
以下に、ユーザーエクスペリエンスに関するDRS認定のガイドラインに準拠するために通信するすべてのエンドポイントの一覧を示します。
| エンドポイント | 必須かどうか | 使用する場合 | SNS通知 |
|---|---|---|---|
| Replenish | はい | デバイスに関連付けられている消耗品を再注文する必要があるとき。 | 注文確定通知が届きます。 |
| Slot status | はい | スロットの内容が消費されたとき。 | なし |
| Device status | はい | 1日1回。 | なし |
| Deregistration | はい | ユーザーがコンパニオンアプリまたはWebからサービスの登録解除をリクエストしたとき。 | デバイス登録解除通知が届きます。 |
| Subscription info | はい | 定期的にユーザーのサブスクリプションステータスを確認するとき、および、オンデマンドでコンパニオンアプリの情報を更新するとき。 | サブスクリプション変更通知が届きます。 |
| Cancel test order | いいえ |
開発中に実装をテストするとき。このAPIはis_test_device:trueの場合に行われた注文に対して機能します。
|
注文キャンセル通知が届きます。 |
| Get order info | はい | Replenishエンドポイントを使用した後に、注文ステータスを確認するとき、およびオンデマンドでコンパニオンアプリの情報を更新するとき。 |
注文が通った場合は、商品発送通知が送信されます。 何らかの理由で注文がキャンセルされた場合は、注文キャンセル通知が届きます。 |
Replenish
このAPIは、ユーザーがスロットで選択したASINの注文を行います。詳細
HTTPメソッド:
POST
パス:
/replenish/{SLOT_ID}
Slot Status
このAPIは、スロットの現在のステータスを報告し、消耗品の量を送信するようリクエストします。詳細
HTTPメソッド:
POST
パス:
/slotStatus/{SLOT_ID}
Device Status
このAPIは、デバイスの現在のステータスを報告し、直近の使用日時を送信するようリクエストします。詳細
HTTPメソッド:
POST
パス:
/deviceStatus
Deregistration
このAPIは、ユーザーのAmazonアカウントからデバイスを登録解除します。詳細
HTTPメソッド:
DELETE
パス:
/registration
Subscription Info
このAPIは、サブスクリプションの現在のステータスを報告します。詳細
HTTPメソッド:
GET
パス:
/subscriptionInfo
Cancel Test Order
このテスト用APIは、開発中に行われたテスト注文をキャンセルします。詳細
HTTPメソッド:
DELETE
パス:
/testOrders/slots/{SLOT_ID}
Get Order Info
このAPIは、注文のステータスを報告します。詳細
HTTPメソッド:
GET
パス:
/getOrderInfo/{eventInstanceId}
次のステップ
次は、DRSから通知を受け取るためのSNSの構成について説明します。
Last updated: Aug 07, 2018