見出し画像

【顧客管理にもおすすめ】企業などの法人情報を取得!経産省のgBizINFO REST API

METI-DX 経済産業省DXオフィス

こんにちは。gBizINFO (Gビズインフォ) を担当している経済産業省DX室の中山ひとみです。

皆さんは、顧客・取引先の情報をどのように管理していますか?
CRMをお使いの方や、Excelで台帳を作成している方など組織によってその方法は多種多様かと思います。
 
取引先の名前を使って管理をする場合、手入力による入力ミスや表記ゆれがあり、名寄せに苦労する…といったこともあるかも知れません。
 
そのような場合は、「法人番号」(国税庁がそれぞれの法人に対して指定する番号) をご利用いただくことをおすすめします。
例えば、経済産業省の法人番号は「4000012090001」です。
法人番号は、国税庁の「法人番号公表サイト」やこれからご紹介する「gBizINFO」で確認することができます。

gBizINFOとは

gBizINFOは、法人番号をもとに官公庁のさまざまなデータを紐付けて提供する経済産業省のオープンデータ サイトです。

gBizINFOでできることを一部ご紹介すると、

  • 法人名で検索を行い、その法人の登記上の所在地や従業員数などの情報か  ら、官公庁からどのような表彰や補助金を受けているか、官公庁の調達で落札した実績があるかといった活動情報を確認

  • 全法人の情報をCSVファイルなどの形式でダウンロード

  • お持ちのCSVファイル(法人名と所在地の列があるもの)に法人番号を付与する

などがあります。

今回の記事は、アプリケーション開発や分析などのためにAPIを利用する方向けの内容となっております。
「gBizINFOについて詳しく知りたい」
「gBizINFOでは、法人情報の検索やファイルがダウンロードできればOK」
という方は、下記のページをご覧ください!

下記のページでもgBizINFOの取組をご紹介しています。

 gBizINFO REST API

さて、本題に入りますが、gBizINFO では、REST API の提供を行っています。API をご利用いただくことで、以下のことが可能になります。

gBizINFO REST API でできること

  • 指定した各パラメーターによる法人の検索

  • 指定した法人番号にひも付く情報の取得

  • 指定した期間内に追加・更新した情報の取得

また、gBizINFO API をサービスにご利用いただいている事例も note に載せていますので、こちらもご覧ください↓

API を利用する準備

API をご利用いただくまでの流れは下記の通りです。

<ご利用までの流れ>
1.    ポリシーの確認
2.    利用申請
3.    メールに記載されたトークンを確認
4.    利用開始!

まずは、REST API ポリシーをご確認いただき、API 利用方法ページ
[4.利用申請] 内 [利用申請ページへ] をクリックして申請に進んでください。

API仕様の確認

gBizINFO REST API は Swaggerで仕様を公開しています。
https://info.gbiz.go.jp/hojin/swagger-ui/index.html.                           

仕様を確認する

それぞれ [∨] をクリックすることで展開し、パラメーターなどの情報をご確認いただけます。

さらに下にスクロールしていただくと、Response Body をご確認いただけます。

上の画像部分にある [Schema] をクリックし、さらに [>] をクリックしていただくと、さらに日本語での項目名が表示されます。


なお、レスポンスボディは全ての API で共通になっていますが、API ごとに返却される範囲は異なります。利用用途に応じて API をご選択ください。

API を実行し、Response を確認する

※仕様ページでは、動作確認用トークンをお使いいただくことができますが、このページ以外でAPIをお試しになる場合は、API利用申請後にお送りするメールに記載されているトークンをご利用ください。

  1. [Try it out!] をクリックしてから、必要なパラメーターを入力します。

2.    [Execute] をクリックします。
Request URLやCurl コマンド、実際のResponseなどを確認できます。

よくある質問

大量にデータを取得する場合はどうする?

全件データや大量の法人の情報が必要となる場合は、ファイルダウンロードをご利用ください。

ファイルは毎日1回更新しており、このファイルを定期的に取得いただくことで、常に新しい情報をご利用になれます。特に、法人の各情報を一括でダウンロードできることができるJSON形式のご利用がおすすめです。

おわりに

 gBizINFO REST API では法人の検索と法人番号にひも付く情報の取得ができ、API仕様や動作はSwagger でご確認いただけます。
ぜひ  gBizINFO REST API をお気軽にお試しいただき、業務などにお役立てください!