テスト環境
SaaS パートナーの連携の開発と検証のために、本番とは別のテスト環境を用意しています。アカウント・クライアント登録・データはいずれも本番とは分離されており、決済は Stripe のテストモードで動作するため実際の請求は発生しません。
アカウントの作成
Section titled “アカウントの作成”テスト環境の画面(https://yubin.stg.atena.dev/)からサインアップしてください。本番のアカウントは利用できません。
ホスト名以外は本番と同じです。パス・リクエスト・レスポンスの形式に違いはありません。
| 用途 | URL |
|---|---|
| ディスカバリ | https://yubin.stg.atena.dev/api/oauth/.well-known/openid-configuration |
| 認可 | https://yubin.stg.atena.dev/api/oauth/auth |
| トークン | https://yubin.stg.atena.dev/api/oauth/token |
| トークン失効 | https://yubin.stg.atena.dev/api/oauth/token/revocation |
| API | https://api.yubin.stg.atena.dev/ |
オートディスカバリを使用するライブラリを使う場合は issuer に https://yubin.stg.atena.dev/api/oauth を渡してください。
テスト環境の client_id と client_secret は本番とは別に発行されます。サポートデスク(de-api@yubin.app)まで申請ください。必要な情報はパートナー向け認証と同じです。
APIリファレンスから試す
Section titled “APIリファレンスから試す”APIリファレンスの Test Request は、Introduction の Server で https://api.yubin.stg.atena.dev を選ぶとテスト環境に送信されます。
認証は環境ごとにスキームが分かれています。Authentication で oauth2(本番環境)のチェックを外し、oauth2Test(テスト環境)にチェックを入れてください。リクエストごとの Authentication でも同じ選択ができます。
Authorize には、リダイレクト URI に https://docs.yubin.app/api-reference/ を登録したクライアントが必要です。申請時にあわせてお知らせください。
クレジットカード
Section titled “クレジットカード”発送依頼の作成にはクレジットカードの登録が必要です(決済)。テスト環境には実在のカードではなく、Stripe のテストカードを登録してください。
| 項目 | 値 |
|---|---|
| カード番号 | 4242 4242 4242 4242 |
| 有効期限 | 現在より先の任意の日付(例: 12/34) |
| CVC | 任意の 3 桁(例: 123) |
| 名義・郵便番号 | 任意 |
カードの登録は API では行えません。テスト環境の画面(https://yubin.stg.atena.dev/)から登録してください。
与信の失敗(402 card_declined)を再現したい場合は、4000 0000 0000 0341 を登録してください。登録は成功し、確定時の与信だけが拒否されます。ほかのケースの番号は Stripe のテストカード一覧にありますが、4000 0000 0000 0002 のように登録の時点で拒否される番号はカードを登録できないため、確定時の挙動の確認には使えません。