API連携(接続情報の発行)
管理画面からクライアントID とクライアントシークレットを発行できます。シークレットは発行時に一度しか表示されません。
接続情報を発行する
メニューの「OAuthクライアント」から発行します。
-
発行画面を開く
ログイン後、メニューの「OAuthクライアント」を選びます。
-
発行する
クライアントIDとクライアントシークレットが表示されます。
-
シークレットを安全な場所に保管する
下記の注意を必ずお読みください。
クライアントシークレットは発行時にしか表示されません
画面を閉じると再表示できません。その場でパスワード管理ツールなど安全な場所に保存してください。
紛失した場合は再発行が必要ですが、再発行すると以前の接続情報は無効になります。稼働中の連携は停止するため、切り替えの段取りを決めてから実施してください。
再発行するとどうなるか
再発行を実行すると、それまでのクライアントと、発行済みのアクセストークンがすべて無効になります。
| 影響 | 内容 |
|---|---|
| 既存の連携 | 認証に失敗し、APIの呼び出しがすべて止まります |
| 発行済みトークン | すべて失効します |
| 復旧方法 | 新しい接続情報を自社システムに設定し直す |
稼働中のシステムがある場合、営業時間中の再発行は避けてください。新しい値を設定し終えるまで、決済や受注の連携が止まります。
シークレットが漏洩した可能性がある場合は、この停止を受け入れてでも直ちに再発行してください。
鍵の取り扱い
| やること | やってはいけないこと |
|---|---|
| 環境変数やシークレット管理ツールに保管する | ソースコードに直接書く |
| サーバ側のプログラムからのみ使う | ブラウザやスマホアプリに埋め込む |
| アクセスできる担当者を限定する | チャットやメールで共有する |
| 担当者の退職時に再発行する | そのまま使い続ける |
問い合わせにシークレットを書かないでください
サポートチケットやチャットにクライアントシークレットやアクセストークンを貼らないでください。当社の担当者がこれらをおたずねすることはありません。
お問い合わせの際はクライアントIDのみをお知らせください。
よくあるエラー
| 症状 | 考えられる原因 | 対処 |
|---|---|---|
| 認証に失敗する(401) | 再発行して古い値のまま/値の写し間違い | 現在の接続情報を設定し直す |
| 権限がないと言われる(403) | その機能が契約に含まれていない | サポートへご確認ください |
| 呼び出しが拒否される(429) | 短時間に呼びすぎている | 間隔をあけて再試行する処理を入れる |
| ときどき失敗する | 一時的な通信・処理の失敗 | 再試行を実装する。決済系は冪等に設計する |
通信が失敗しても、相手側では処理が完了している場合があります。同じ処理を二度実行しても結果が変わらないよう、取引IDで重複を判定する設計にしてください。
連携前に検討すること
決済リンクで済む用途であれば、API連携は不要です。 決済リンクは開発なしで使え、Webhookで自社システムへ結果を通知することもできます。
API連携が向いているのは次のような場合です。
- 自社の会員システムと残高を同期したい
- 大量の取引を自動で処理したい
- 独自の購入画面を自社で用意したい
技術的な仕様についてのお問い合わせは、サポートチケットに呼び出したAPI・送ったリクエストの概要・返ってきたエラーを添えてご連絡ください。繰り返しになりますが、シークレットは書かないでください。
Did this page help?
Your answer tells us which pages need rewriting.
- 事業者名
- 発行済みのクライアントID(シークレットは絶対に書かないでください)
- 呼び出したAPIと、返ってきたエラーの内容
Never include your password, verification codes or card PIN. How tickets work