APIシークレットキーを作成する(マーチャントAPI)
概要
マーチャントAPIアドオン機能で、APIシークレットキーを新規に発行・作成する方法を説明します。
利用目的
マーチャントAPI用のAPIシークレットキーを組織単位で発行・管理することで、外部の基幹システムや物流システム、会計ソフトなどとの連携に使う認証情報を、用途ごとに分けて一元管理することを目的としています。
連携先ごとにキーを分けることで、どのシステムがどの認証情報を使っているかを整理し、運用と権限の見通しを保ちやすくします。
機能の説明
マーチャントAPIとAPIシークレットキー
マーチャントAPIアドオンは、外部の基幹システムや物流システム、会計ソフトなどとDEXTREのデータを連携・活用するためのAPI提供機能です。
DEXTREと外部アプリケーション(サーバー)とのデータ連携には、専用のAPIシークレットキーが必要です。
本機能では、DEXTREのAPIシークレットキーを発行・作成できます。
利用可能なエンドポイントや認証方法などの詳細は、DEXTRE Merchant APIドキュメントを参照してください。
利用の前提条件
マーチャントAPIの連携機能を利用するには、あらかじめマーチャントAPIアドオンのサブスクリプションを契約し、有効化しておく必要があります。
契約に関する詳細は、マーチャントAPIアドオンを契約するを参照してください。
操作方法
APIシークレットキーの作成画面への移動
- メーカー設定 > メーカー設定を開くをクリックします。
- APIをクリックします。
- 新規キーの作成をクリックします。
「新規APIシークレットキーの作成」モーダルが開きます。
フォームの入力方法
-
名前(必須)
APIシークレットキーの名称を入力します。 -
概要(任意)
APIシークレットキーの概要を入力します。
APIシークレットキーを作成する
発行されたAPIシークレットキーは、発行時に一度だけしか表示されません。
システム上で後から再表示することはできません。
-
入力内容を確認のうえ、作成ボタンをクリックします。
APIシークレットキーが発行されます。 -
作成されたAPIシークレットキー
表示されたAPIシークレットキーを、安全な場所に保管します。 -
APIシークレットキーを安全な場所に保管しました。
APIシークレットキーを安全な場所に保管したら、チェックを入れます。 -
閉じるボタンをクリックします。
利用上の注意
APIシークレットキーを安全な場所に保管してください
発行されたAPIシークレットキーは、発行時に一度だけしか表示されません。
システム上で後から再表示することはできないため、作成時に必ず安全な場所に保管してください。
連携先ごとにAPIシークレットキーを運用してください
1つの連携先アプリケーション(サーバー)に対して1つのAPIシークレットキーを発行して使用することを推奨します。
複数の連携先で1つのAPIシークレットキーを使い回すことは非推奨です。
マーチャントAPIのリクエスト制限
マーチャントAPIには、次のリクエスト制限があります。
- マーチャント(メーカー組織)ごとに 300リクエスト / 分
制限を超過した場合、リクエストは失敗し、エラーが返却されます。
※技術的には 429 Too Many Requests が返却されます。