APIリファレンス
DEUNAの各統合フローに適したAPI操作、認可モデル、呼び出し元を選択します。
DEUNA APIリファレンスは、以前のドキュメントで公開されていた加盟店バックエンドおよび顧客アプリケーション向けの操作を対象とします。対応する認可モデルはAPIサーフェスによって異なるため、リソース名だけでなく呼び出し元から確認してください。その他のAPI Gatewayルートは、このリファレンスから意図的に除外されています。
API リファレンスのナビゲーションを使用して、製品領域とリソース別に公開済み操作を参照します。
注文・決済リクエスト例業界別の完全な Purchase V2 リクエストと任意の注文作成リクエストをコピーします。認証各呼び出し元に適した認証情報と認可モデルを選択します。決済を作成する完全な支払い契約とインタラクティブなリクエストパネルを確認します。Themes API再利用可能なCheckoutおよびWidgetテーマ設定を作成・管理します。
基本 URL#
開発中は、サンドボックスの基本 URL を使用してください。 導入資格情報を受け取り、認証プロセスを完了したら、本番環境に切り替えてください。
サンドボックス
https://api.sandbox.deuna.io
本番環境
https://api.deuna.io
API を選択する#
| 表面 | 意図する呼び出し元 | 認証 | これを使用してください |
|---|---|---|---|
| 商社バックエンド · サーバー間 | 信頼できる商社インフラ | プライベートAPIキーを X-Api-Key; X-Store-Code および、必要な場合にアイデンポテンツヘッダーを送信 | 注文、購入、売上確定、返金、取消、および運用上の参照 |
| 顧客アプリケーション · ユーザーからサーバーへの通信 | 商社ウェブまたはモバイルアプリケーションが顧客を代理 | 公開アプリケーションコンテキストとユーザー Authorization: Bearer … ログイン後、プライベートキーを埋め込まない | 任意のログイン、再利用可能なプロフィールと住所、保存済みカード |
認証#
商社側のバックエンド
プライベートAPIキーを X-Api-Key、ベアラーヘッダーではなく送信。信頼できるサーバーインフラストラクチャに保持。
サーバーからサーバーへのリクエストヘッダーHTTP
X-Api-Key: YOUR_PRIVATE_API_KEY
X-Store-Code: STORE_CODE
X-Idempotency-Key: order_1042-attempt_1
Content-Type: application/json認証された顧客
ユーザーアクセストークンを Bearer ヘッダーで送信します。一部の注文操作とウォレット操作では、加盟店アプリケーションキーまたはストアコンテキストも必要です。各操作ページに認可と転送ヘッダーが記載されています。
クライアントからサーバーへのリクエストヘッダーHTTP
Authorization: Bearer USER_ACCESS_TOKEN
X-Api-Key: APPLICATION_API_KEY
X-Store-Code: STORE_CODE
Content-Type: application/json参照 認証 認証情報、トークンの有効期限、およびローテーションの管理
商社のバックエンド操作#
POSTGETGETPOSTPOSTPOSTGET
/merchants/orders
注文を作成し、注文トークンを取得する
/merchants/orders/{order_token}
現在の注文と支払い状況を取得する
/merchants/orders/{order_token}/payments-methods
注文で使用可能な支払い方法を取得する
/v2/merchants/orders/purchase
決済を作成する
/v2/merchants/orders/{order_token}/capture
承認された決済を実行
/v2/merchants/orders/{order_token}/refund
完全または部分的な返金を生成
/merchants/checkout/themes
加盟店のCheckoutテーマを一覧表示・管理します
顧客アプリケーションの操作#
POSTPOSTGETGETPATCH
/users/request-code
一時的なログインコードをリクエストする
/users/login
OTPをユーザートークンと交換する
/users/me
認証されたユーザーのプロファイルを読み取る
/users/{user_id}/cards
認証されたユーザーの保存されたカードを一覧表示する
/users/{user_id}/cards/{card_id}/set-as-default
認証済みユーザーのデフォルトカードを設定または解除
レスポンスとエラー#
2xxリクエストは成功しました。
4xx認証、権限、状態、またはリクエストデータが変更されている必要があります。返されたエラーコードを確認してください。
5xxDEUNAまたはプロバイダーが失敗しました。オペレーションがidempotentな場合にのみ、同じidempotencyキーを使用して再試行してください。
完全なリストは、[参照]で確認できます。 エラーコード.
パスのバージョン管理#
各パスをそのまま公開されているものとして使用してください。API Gatewayは、内部のプレフィックスなしで、標準的なルートを頻繁に公開します。 /api/v1 バージョンセグメント(例: /v2 は、カタログに表示されている公開ルートの一部である場合にのみ含まれます。 互換性を維持した変更は、次のリストに記載されています。 Changelog.