Sandbox環境¶

登記くんでは、お客様の接続確認・開発検証用にSandbox環境を用意しています。

Base URL¶

https://sandbox.tychy.jp

本番環境のBase URLは https://api.tychy.jp です。本番移行時は、Base URLとAPIキーを本番用に切り替えてください。

APIキー¶

Sandbox環境を利用するには、Sandbox用APIキーが必要です。

Sandbox用APIキーをご希望の場合は、support@tychy.jp までお問い合わせください。お客様からリクエストをいただいた場合のみ、Sandbox環境専用のAPIキー（env=sandbox）を発行します。

Warning

Sandbox用APIキーは本番環境では利用できません。本番用APIキーもSandbox環境では利用できません。

課金について¶

Sandbox環境でのリクエストは検証用です。実際の請求対象にはなりません。

レスポンスの message や is_charged に課金対象を示す値が含まれる場合がありますが、Sandbox環境では実請求されません。

疎通確認¶

curl -H "Authorization: Bearer <SANDBOX_API_KEY>" \
  https://sandbox.tychy.jp/v1/ping

登記簿取得の例¶

curl -H "Authorization: Bearer <SANDBOX_API_KEY>" \
  https://sandbox.tychy.jp/v1/toukikun/9011001155105

PDFを取得する場合は、上記レスポンスの file_id を指定します。

curl -H "Authorization: Bearer <SANDBOX_API_KEY>" \
  https://sandbox.tychy.jp/v1/getpdf/<file_id> \
  --output toukibo.pdf

テスト用法人番号¶

Sandbox環境での接続確認には、以下の法人番号をご利用ください。

法人番号	期待結果	用途	補足
`9011001155105`	200 OK	基本的な正常系の疎通確認	登記簿取得、レスポンスJSON確認、PDF取得の一連の確認に利用できます。
`3280002295087`	200 OK	処理時間が長いケースの確認	初回取得時に約15秒待ってからレスポンスします。タイムアウト設定や待機表示の確認に利用できます。
`8011301895986`	200 OK	タイムアウト・再試行の確認	初回取得時に約35秒待ってからレスポンスします。クライアント側のタイムアウト、再試行、非同期処理の確認に利用できます。
`9011001155104`	404 Not Found	Not Foundエラーの確認	存在しない法人番号として扱われます。エラーハンドリングの確認に利用できます。

Note

Sandbox環境のテスト用法人番号は、接続確認・開発検証用です。正常系で返るPDFは検証用のサンプルPDFです。そのため、法人番号ごとに異なる実在法人の登記情報が返ることを保証するものではありません。本番相当の請求・課金確認ではなく、API連携の疎通、レスポンス形式、PDF取得処理、タイムアウト・再試行処理の確認にご利用ください。

確認できること¶

テスト用法人番号では、主に以下を確認できます。

APIキー認証が成功すること
GET /v1/toukikun/:houjinNumber でJSONレスポンスを取得できること
レスポンスに含まれる file_id を使って GET /v1/getpdf/:id でPDFを取得できること
キャッシュ済みの場合に、message が [非課金] キャッシュから取得、is_charged が false になること
処理時間が長いリクエストに対するタイムアウト・再試行処理
404エラー時のハンドリング

本番移行時の変更点¶

本番環境へ移行する際は、以下を切り替えてください。

項目	Sandbox	本番
Base URL	`https://sandbox.tychy.jp`	`https://api.tychy.jp`
APIキー	Sandbox用APIキー	本番用APIキー
用途	接続確認・開発検証	実運用