つないでみよう：#12）インボイス API の仕様

WebAPI 連携日記の第 12 回です。今回は国税庁のインボイス API の仕様を確認します。

API のドキュメント

まずは、API の仕様について確認します。詳細な仕様は PDF ファイルで提供されています。

Web-API機能のリクエストの設定方法及び提供データの内容について（Ver.1.0）

まとめると次の通りです。

リクエスト方法

まずは、WebAPI に接続するための URL は次の通りです。

https://web-api.invoice-kohyo.nta.go.jp/1/num?parameters

? 以降には、検索条件となるパラメータを指定します（後述）。使用する HTTP のメソッドは GET で、検索条件をすべて URL に記述するパターンとなります。

なお、URL 内の ”1” はバージョンで、現時点では 1 しか存在しません。

パラメータ

インボイス API で使用するパラメータをまとめます。

id	○	アプリケーション ID
number	○	検索する登録番号（T + 13 桁の数字）
type	○	応答形式 　01：CSV形式 　11：XML形式 　21：JSON形式
history		履歴情報要否 　0：なし 　1：あり

API のテスト

リクエスト方法がわかったので、応答形式は JSON、履歴情報はなしでテストします。  Postman に次の通り、HTTP のメソッド、URL パラメータを入力します。登録番号はいつもお世話になっている ”鳥貴族” を使用しました。

実行すると、すぐレスポンスが返ってきました。API のテストツールは本当に便利ですね。

参考までにこのテストの URL は次の通りとなりました。これをプログラムで生成して送信すればいいというわけですね。

https://web-api.invoice-kohyo.nta.go.jp/1/num?                 id=xxxxxxxxxxxxx&                 number=T9120001011712&                 type=21&                 history=0

レスポンスのフォーマット

ドキュメントには、JSON 形式のレスポンスは下図の通り記載されていました。ヘッダ情報にヒット件数が入っています。公開情報セクションがヒットした情報の詳細で、件数分の配列となる構造となっています。

今回は、登録番号を使っての検索ですので、結果が 0 件の場合は入力ミスと言えます。ヒットした場合、名称を確認して正しいかを判断すればよいということですね。

前回

連載：つないでみよう

次回