Referencia de API
各統合フローに対して、適切な DEUNA API、認証モデル、および呼び出し元を選択してください。
DEUNA は、加盟店バックエンド、顧客アプリケーション、パートナー、プロバイダーコールバック向けの公開 API を提供します。リソース名だけでなく呼び出し元から確認してください。対応する認証モデルは API サーフェスごとに異なります。内部の Admin API と管理 API は意図的に除外されています。
以下の 完全なエンドポイントカタログ 構成された API Gateway の操作を、意図するユーザー、所有サービス、認証、またはヘッダーに基づいて検索します。
基本 URL#
開発中は、サンドボックスの基本 URL を使用してください。 導入資格情報を受け取り、認証プロセスを完了したら、本番環境に切り替えてください。
API を選択する#
| 表面 | 意図する呼び出し元 | 認証 | これを使用してください |
|---|---|---|---|
| 商社バックエンド · サーバー間 | 信頼できる商社インフラ | プライベートAPIキーを X-Api-Key; X-Store-Code および、必要な場合にアイデンポテンツヘッダーを送信 | 注文、購入、決済、払い戻し、キャンセル、同意、および運用関連のデータ |
| 顧客アプリケーション · ユーザーからサーバーへの通信 | 商社ウェブまたはモバイルアプリケーションが顧客を代理 | 公開アプリケーションコンテキストとユーザー Authorization: Bearer … ログイン後、プライベートキーを埋め込まない | ログイン、プロフィール、住所、保存されたカード、および顧客によるウォレット連携 |
| ネットワークまたはパートナー側のバックエンド | 承認されたネットワークまたはプラットフォームとの統合 | パートナーの認証情報と、オンボーディング時に定義されたテナント/ネットワークコンテキスト | ネットワーク範囲の注文、設定、およびレポート |
| プロバイダからのコールバック · プロバイダからDEUNAへの通信 | 決済、不正検知、ウォレット、またはプラットフォームプロバイダー | プロバイダ固有のコールバック契約; ゲートウェイは、所有サービスにコールバックヘッダーを転送し、共有の認証検証器を宣言しない | 非同期のステータス通知; 商社システムはこれらのルートを呼び出すべきではない |
認証#
商社側のバックエンド
プライベートAPIキーを X-Api-Key、ベアラーヘッダーではなく送信。信頼できるサーバーインフラストラクチャに保持。
X-Api-Key: YOUR_PRIVATE_API_KEY
X-Store-Code: STORE_CODE
X-Idempotency-Key: order_1042-attempt_1
Content-Type: application/json認証された顧客
ユーザーアクセストークンをベアラーヘッダーに送信。一部の注文およびウォレット関連の操作では、商社アプリケーションキーまたはストアコンテキストも必要となる。 エンドポイント: カタログ 各ルートにおける認証および転送ヘッダーを表示します。
Authorization: Bearer USER_ACCESS_TOKEN
X-Api-Key: APPLICATION_API_KEY
X-Store-Code: STORE_CODE
Content-Type: application/jsonパートナー
パートナーの認証情報とネットワークコンテキストは、オンボーディング時に提供されます。チェックアウト用のプライベート API キーをパートナー認証情報として使用しないでください。
詳細は 認証 認証情報、トークンの有効期限、およびローテーションの管理
商社のバックエンド操作#
顧客アプリケーションの操作#
プロバイダーからのコールバック#
プロバイダーのコールバックルートは、完全なインベントリの一部であり、チームは所有者を特定し、誤って呼び出すことを防ぐことができます。これらは商社のウェブフックではありません。DEUNAのイベントを独自のバックエンドで受信するには、注文のウェブフックURLを設定し、次の手順に従ってください。 Webhooks.
レスポンスとエラー#
完全なリストは、[参照]で確認できます。 エラーコード.
パスのバージョン管理#
各パスをそのまま公開されているものとして使用してください。API Gatewayは、内部のプレフィックスなしで、標準的なルートを頻繁に公開します。 /api/v1 バージョンセグメント(例: /v2 は、カタログに表示されている公開ルートの一部である場合にのみ含まれます。 互換性を維持した変更は、次のリストに記載されています。 Changelog.