連携ガイド¶
登記くんAPIは、Slack Bot、Google Apps Script、審査システム、CRM、社内管理画面などから利用できます。このページでは、連携時に押さえるべき設計ポイントと参考記事をまとめます。
連携の基本フロー¶
登記くんAPIを組み込むときは、お客様のアプリから 必要に応じて2つのAPI を呼び出します。
1法人番号を入力・選択する
利用者が社内システム、Slack Bot、GASなどで対象法人を指定します。
2登記簿情報とPDFリンクを取得する
お客様アプリが GET /v1/toukikun/{法人番号} を呼び出します。レスポンスには解析済みの法人情報、PDFリンクの signed_url、PDF取得用の file_id が含まれます。
3PDFファイルとして取得する場合
signed_url でPDFを参照できます。PDFをAPI経由でダウンロードして保存したい場合は、GET /v1/getpdf/{file_id} を呼び出します。
4結果を業務画面に反映する
法人名、所在地、代表者、役員情報などを表示・保存し、必要に応じてPDFへのリンクやファイルを添付します。
実装時のポイント¶
| ポイント | 対応 |
|---|---|
| タイムアウト | 登記簿取得は30秒以上かかる場合があります。初回タイムアウト後も処理は継続されるため、時間を置いて同じ法人番号で再試行してください。 |
| キャッシュ | 同じ法人番号は3日間キャッシュされます。キャッシュ期間内の再取得は課金対象外です。 |
| レート制限 | 認証済みユーザーは60 requests/minです。429 の場合は待機して再試行してください。 |
| エラーハンドリング | 404、512、513、517 など業務判断が必要なエラーを分岐してください。 |
推奨リトライ方針¶
| 状況 | 推奨対応 |
|---|---|
504 Gateway Timeout |
30秒ほど待って同じ法人番号で再取得する |
202 Accepted |
他のリクエストで処理中。少し待って再取得する |
429 Too Many Requests |
レート制限。指数バックオフなどで再試行する |
512 / 513 |
登記簿提供サイト側の営業時間外・一時障害。時間を置いて再試行する |
517 Large Touki Not Supported |
現在未対応。手動取得など別運用を検討する |
参考実装・記事¶
具体的な連携方法は、以下の記事で紹介しています。
- Slack Bot から取得する
- ベースマキナから取得する
- Google Apps Script から取得する
Note
各記事は参考情報として提供しています。外部サービスの仕様変更などにより、手順が最新の状態と異なる場合があります。API仕様は本ドキュメントの API仕様 を正としてください。