Sandbox環境¶

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

Production 本番利用用 https://api.tychy.jp

実際の登記簿取得に利用します。契約プラン・取得件数に応じて課金されます。

Sandbox 開発・検証用 https://sandbox.tychy.jp

認証、レスポンス形式、PDF取得、タイムアウト時の再試行処理を確認できます。実請求の対象外です。

Sandbox利用時の注意

Sandbox用APIキーはSandbox専用です。本番用APIキーとは分けて管理してください。

APIキー¶

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

Warning

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

APIキー認証を確認
/v1/ping が ping を返せば認証成功です。

登記簿取得を確認
テスト用法人番号で /v1/toukikun/:houjinNumber を呼び出します。

PDF取得を確認
レスポンスの file_id を /v1/getpdf/:id に渡します。

1. Ping

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

2. Fetch registry data

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

3. Download PDF

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

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

Note

Sandbox環境のテスト用法人番号は、接続確認・開発検証用です。正常系で返るPDFは検証用のサンプルPDFです。法人番号ごとに異なる実在法人の登記情報が返ることを保証するものではありません。

本番移行時は、Base URLとAPIキーを本番用に切り替えてください。