ページの本文へ

FAQ

外部連携APIの仕様について

Q1:外部連携APIとは何でしょうか。

A:e-Gov電子申請システムが具備する機能(申請データ一括送信、状況照会、到達確認、取下げ、補正、公文書取得等)を、任意のソフトウェアをフロントエンドとして利用するためのAPI(Application Programming Interface)を提供するものです。
外部連携APIの構成と概要については、「外部連携API API概要PDF」をご確認ください。

Q2:一括申請仕様公開と異なる点は何でしょうか。

A:一括申請仕様公開は、申請データの構造仕様を公開するもので、一括申請仕様に対応したソフトウェアによって作成した申請データをe-Gov電子申請システムにアップロードすることにより一括送信できるようにすることを目的としたものでしたが、外部連携API仕様公開は、外部のソフトウェアがe-Gov電子申請システムに具備する機能を直接利用するためのAPI(Application Programming Interface)を提供することを目的とするものです。
外部連携APIを利用するソフトウェアの開発により、一括申請では、Javaアプリケーションを利用してe-Gov電子申請システムのウェブサイトにおいて行う必要があった申請後の状況照会、到達確認、公文書取得等の操作を、全てソフトウェアに実装することができるようになります。

Q3:外部連携APIの仕様書等一覧にも「申請データ仕様共通データ仕様書」が掲載されていますが、一括申請のものとどこが違っているのでしょうか。また、一括申請用に作成した申請データを外部連携APIに投入することはできるのでしょうか。

A:外部連携APIの「申請データ仕様共通データ仕様書」には、取下げや補正を行う場合に必要となるデータ構造等仕様が追加されています。
なお、申請データ自体のデータ構造等仕様は、一括申請のものと互換性があるため、一括申請公開仕様に準拠した申請データを外部連携APIに投入すること自体は可能です。

Q4:一括申請のような検証環境の利用案内が掲載されていないようですが、外部連携APIのテスト環境としてe-Govの検証環境を利用することはできないのでしょうか。

A:外部連携APIのテスト環境としてe-Gov検証環境の利用を可能としています。「外部連携API利用ガイドPDF」に利用手順に関する記載がありますのでご確認ください。

Q5:現在、一括申請に関するソフトウェア開発のため検証環境を利用していますが、引き続き外部連携APIのテストのために検証環境を利用することはできますか。

A:できません。外部連携APIのテストのために検証環境を利用するためには、別途「外部連携API利用ガイドPDF」に示す手続が必要です。必要な手続がない状態で検証環境を利用された場合は、接続を制限する場合があります。

Q6:外部連携APIの仕様に関する説明会は開催されないのでしょうか。

A:平成26年11月5日と27日に説明会を開催いたしました。配布資料はこちらで公開をしております。今後の説明会の開催予定は未定です。

Q7:外部連携APIの利用に当たって、開発言語の指定等はあるのでしょうか。

A:特に指定はありません。

外部連携API対応のソフトウェアについて

Q1:現時点で利用できるe-Govの外部連携APIに対応したソフトウェアは何か存在するのでしょうか。

A:平成29年4月現在複数のソフトウェア・サービスが提供されています。詳細は、ソフトウェアを利用して電子申請をお使いいただく方へをご参照ください。

Q2:外部連携APIに関する仕様が公開されましたが、現在のe-Gov電子申請システムの利用者もすぐに外部連携APIを利用した電子申請ができるようになるのでしょうか。

A:別途e-Gov外部連携APIに対応するソフトウェアを入手いただくことが必要です。
なお、入手可能時期に関する情報提供を行う予定はありませんので、あらかじめご留意ください。

Q3:e-Govの外部連携APIに対応したソフトウェアに関する情報はe-Govのウェブサイトで案内されるのでしょうか。

A:外部連携API対応のソフトウェアに関する情報提供をe-Govのウェブサイトにおいて行う予定はありません。

Q4:一括申請に対応したソフトウェアを使用して外部連携APIを利用することはできるのでしょうか。

A:ご利用いただいている一括申請対応ソフトウェアの開発・販売元にお問い合わせください。

今までのお問合せ内容のまとめ

お寄せ頂きましたお問合せについて一覧表にまとめて公開いたします。各APIについての細かな内容なども含まれておりますので、開発をご検討されている場合には「こちらPDF」をご確認ください。