API機能
API機能とは
本APIは、アフィリコード・カートが提供するデータを外部のアプリケーションやプログラムから扱うための機能を提供するインターフェースです。
APIで取得した情報を利用して、カート運営者が新しいサービスを展開することができます。
- アプリや新たなサービスのUIを別に用意し、API連携によって決済自体はカート機能に集約
- 外部の在庫管理システムと受発注情報を連携
1. APIキーの取得
APIの利用に際し、OAuthアクセストークンで認証を行います。
管理者のアカウント詳細画面よりAPIキー(アクセスキー、シークレットキー)を取得し、リクエストヘッダに設定します。※シークレットキーは管理画面より再発行が可能。
リクエストヘッダの書式
- X-Auth-Token アクセスキー:シークレットキー ※コロンで結合
2. 対象データと操作
HTTP通信を利用し、RESTful APIのガイドラインに沿って設計されています。リクエストURIに要求された情報を付与し、該当データをJSON形式で返却します。
2021年11月現在、APIは以下種類の情報が扱えます。
API | HTTPメソッド | |
---|---|---|
商品 | 登録 | POST |
編集 | PUT | |
取得(1件・複数) | GET | |
削除 | DELETE | |
注文 | 取得(1件・複数) | GET |