# Bango API

Bango APIは、国税庁の法人番号APIとインボイス登録番号APIを統合し、法人番号やT番号ひとつで企業情報とインボイス有効性をJSONで返すAPIです。表記ゆれの一括名寄せや過去日付の有効性確認にも対応します。

## APIの基本情報

- ベースURL: https://api.bango-api.jp/v1
- 認証: x-api-key リクエストヘッダーにAPIキーを指定する（OpenAPI仕様に載る全エンドポイントで必須）
- 無料枠: Free プランあり。月500コール。通常API全エンドポイント利用可（バッチ名寄せ不可）。表示価格は税込。
- レスポンス: OpenAPI仕様に載るエンドポイントの成功時JSONは共通エンベロープ（object / schema_version / data / links / meta）で返る。未知のフィールド・未知のenum値は無視して処理すること
- エンベロープの例外: エラーは problem+json で返るため包まれない。バッチ結果のダウンロードは ?format=csv を指定した場合のみ text/csv で返り包まれない（既定の json はエンベロープ）
- エラー: RFC 9457（application/problem+json）。type は https://bango-api.jp/docs/errors#<エラーコード> を指す
- レート制限: 認証成功済みのレスポンス（エラー応答を含む）に X-RateLimit-Limit / X-RateLimit-Remaining / X-RateLimit-Reset（epoch秒）を送出。429・503 には Retry-After（秒）を追加。401 などプランを特定できない応答にはレート制限ヘッダーは付かない

## リンク

- OpenAPI仕様: https://bango-api.jp/openapi.json
- ドキュメント / クイックスタート: https://bango-api.jp/docs
- エラーリファレンス: https://bango-api.jp/docs/errors
- 料金プラン: https://bango-api.jp/pricing