API全般について利用手続について

API全般について
Question
提出先の統廃合等により、提出先情報に変更が生じた場合、
1 どのような形で通知が行なわれるのでしょうか？
Answer
提出先情報に関わらず、全ての変更情報は、e-Govウェブサイトに掲載し、あわ
せてRSSフィードが配信されます。
2
送信・受信に関するモジュール等の配布予定はあるのでしょう
か。
3
外部連携APIで利用可能な電子証明書にはどのようなものがあ現在のe-Gov電子申請と同様の電子証明書が利用可能です。
るのでしょうか。
別々のソフトウェアを同じ利用者が利用する場合、利用者ID登
録用の電子証明書も複数用意する必要はあるのでしょうか。
１つの電子証明書で複数のソフトウェアが利用可能です。
4
既存の一括申請機能と外部連携APIにて使用する申請のZIP
データは同一でしょうか。
同一の仕様に基づく申請データを使用しております。
5
既存の電子申請について、用語などに関する資料は無いので
しょうか。
「e-Gov電子申請システムご利用ガイド」を参考情報として御案内いたします。
（URL：http://www.e-gov.go.jp/help/shinsei/index.html）
ご不明点については、お手数ですが個別具体的に御照会いただけますようお願
いいたします。
6
7
8
9
モジュール等の配布予定はありません。
外部連携APIに対応するソフトウェアが入手可能となった後につ一括申請機能は、将来的な廃止を予定しております。
いても、一括申請機能は利用できるのでしょうか。
但し、API公開後、即座に廃止することはございません。
廃止時期については、利用状況を注視しつつ、一括申請での申請頻度が一定以
下になった時点で検討を行います。
外部連携APIの仕様は、マイナンバー制度が実施された後でも現在公開されております外部連携API仕様には、マイナンバー制度実施後の想
問題無い様にセキュリティ設計されているのでしょうか。
定は含んでおりません。
マイナンバー制度への対応については今後の検討対象となります。
APIを利用して電子申請を行った手続について、手続途中から
e-Gov（電子政府の総合窓口)のWebサイトを用いることはできま
すでしょうか。
また、逆にWebサイトから電子申請を行った手続について、手続
途中からAPIを用いることはできますでしょうか。
e-Gov（電子政府の総合窓口）のWebページを用いた申請とAPIを用いた申請で
は利用者識別の手法が異なります。
従って、申請後、手続進行中のデータについて、WebページとAPIを相互に途中
から切り替えることは出来ません。
利用手続について
Question
Answer
最終確認試験に合格したソフトウェアについて、改修を行う場合基本的に、ソフトウェアのバージョンアップが行われる場合には、新規のソフト
にはソフトウェアＩＤの扱いはどのようになるのでしょうか。
ウェアIDの発行が必要です。
但し、ソフトウェアIDは、ソフトウェアにおける外部連携APIとの通信を行う実装部
分を一意に識別することを目的としています。
従って、外部連携APIとの通信を行う部分に変更が発生していない場合には新
規のソフトウェアID発行を受ける必要はありません。
また、ソフトウェアIDはソフトウェア単位での発行を行なうものですので、新規ソフ
トウェアの発行を受けた場合には、機能に変更が無い部分であっても、新規のソ
フトウェアIDでアクセスを行なうようにしてください。
1
2
ソフトウェアの改修を行い、新しくソフトウェアIDを取得した場
ソフトウェアIDが異なる場合、別個のソフトウェアとして判別されますので、
合、旧いバージョンのソフトウェアIDは継続して利用可能なので旧いバージョンのソフトウェアIDについても引続き利用可能です。
しょうか。
APIを利用して電子申請を行う製品が複数存在する場合、
「API利用ソフトウェア開発申込書」は製品数に応じて作成して
申し込む必要がありますでしょうか。
「API利用ソフトウェア開発申込書」は、製品数に応じて作成の上、必要通数を御
送付ください。
但し、それぞれが独立した実装によりAPIを利用する設計ではなく、APIとの通信
を行う実装が共通化されており、同一の実装とすることができる場合には、１通
の「API利用ソフトウェア開発申込書」に集約することができます。
3
複数の製品についてAPIとの通信を行う実装が共通化されているケースにおい
ては、
「API利用ソフトウェア開発申込書」のソフトウェア欄には、該当する全ての商品を
併記してください。
現時点での最新バージョンの記入をお願いいたします。
4
「API利用ソフトウェア開発申込書」のソフトウェアの項目には、
どのバージョンを記入すればよろしいでしょうか。
5
利用者ID削除の方法にはどのようなものがありますでしょうか。利用者ID削除申込を行っていただくことで利用者IDの削除が行なえます。
また、数年程度の期間、利用実績の無い利用者IDは自動的に削除されます。
6
検証環境は、検証環境利用申込書を送ればいつでも使えるよう検証環境は、メンテナンス等を除き常時公開となります。
になるのでしょうか。
利用については、申込書を受領後一定期間後に利用可能となります。
情報セキュリティ要求仕様書について
Question
「2.1 ソフトウェアID、利用者ID及びアクセスキーの厳重な管理」
に、「API利用ソフトウェアは、外部にソフトウェアIDと利用者IDを
出力する際は、出力情報を暗号化・難読化を行う仕様とする」と
1
いう記述がありますが、具体的な暗号化、難読化の要件はある
のでしょうか。
Answer
具体的な暗号化・難読化の要件については指定はありません。
ソフトウェアを開発される各社の基準にて、適切なセキュリティ水準を満たすよう
に暗号化・難読化を行っていただければ構いません。
個々のAPIについて
Question
Answer
利用者ID登録
1
一度、利用者IDの登録を行なった後、
同じ利用者IDで別のソフトウェアが認証可能でしょうか。
既に登録されている利用者IDでのアクセスですので、
そのまま利用者認証を行うことが可能です。
利用者認証
利用者認証の際、外部連携APIの応答結果に前回成功した認
証日時が含まれているのは何故でしょうか。
1
2
3
セキュリティ向上の為です。
前回の認証日時をソフトウェア利用者に視認させることにより、利用者の意図し
ない時間に不正にアクセスが行われていないかどうか、
確認させることができるようになります。
利用者認証に伴って発行されるアクセスキーの有効期限はどのセキュリティの関係上、本番環境のアクセスキー有効期限は公表いたしません。
くらいでしょうか。
一度認証処理を行いアクセスキーが発行された後、アクセス
新たなアクセスキーが発行され、以前のアクセスキーは無効となります。
キーの有効期限内に再度認証処理をした場合、新たなアクセス
キーは発行されるのでしょうか。
一括申請
応答結果の「送信申請件数」、「エラー件数」の集計条件はどの zipファイル1通に2件の申請データを格納して送信した場合、送信申請件数：2件
ようなものでしょうか。
となります。
これは、申請内容にエラーがあるかどうかに関わらず2件になります。
申請データを構成するファイルにエラーが合った場合には「エラー件数：1件」で
応答し、処理上はzipファイルを丸ごと差戻ししたのと同じ状態になります。
エラー件数のカウントは、エラーの個数であり、エラー原因の申請件数ではあり
ません。従って、エラー原因箇所が同一申請内に3種類存在していた場合は「エ
ラー件数：3件」となります。
1
送信案件一覧情報取得
1
応答結果の「補足メッセージ」には、どのような内容が格納され申請内容のチェックを行なうバッチ処理にてエラーが発生した際のメッセージが
ますでしょうか。
格納されます。
状況照会
状況照会はどのような場合に使用するのでしょうか。
状況照会は、到達番号採番以降の事務処理状況を確認するために使用します。
例えば、申請届出の結果として何らかの公文書等が発行される手続の場合、公
文書が発行されたか否かは、到達番号を指定して状況照会を行うことにより確
認することができます。
申請処理状況のメインステータスについて、
「審査終了」と「手続終了」にはどのような違いがあるのでしょう
か。
審査完了と手続完了は、電子公文書の有無によって異なります。
1
2
電子公文書が発行されない手続の場合、府省での審査が終了すると即座に「手
続終了」になります。
電子公文書が発行される手続の場合、一度「審査終了」になった後、申請者が電
子公文書をダウンロードし、公文書取得完了処理を行うと「手続終了」になりま
す。
取下げ
「取下げ依頼」と「取下げ申請」にはどのような違いがあるので
しょうか。
1
補正(補正申請)
取下げ依頼と取下げ申請では、取下げ手続の際に送信するデータフォーマット
が異なります。
取下げ依頼と取下げ申請のどちらを持ちいるか、については
状況照会APIにて取得可能なパラメータに含まれる[WithdrawType：取下げ方法]
の値を用いて判別を行います。
※従って、取下げを行う前には必ず状況照会を一度は行う必要があります。
1
厚生労働省所管の手続しか行なわない場合、「API概要」資料その通りです。
の「3.8.補正通知一覧取得」「3.9.補正(再提出)」「3.10.補正(部分
補正)」のAPI機能は、使用しないと考えてよろしいでしょうか。
別送情報とはどのようなものでしょうか。
2
3
4
5
補正申請時、添付書類が電子ファイルで準備出来ない場合などに、郵送にて別
途提出した書類があり、補正申請時にその旨を記入していた場合、その情報が
格納されます。
「別送書類送り先情報」については、別送書類の送付先機関名が格納されます。
補正期限を過ぎて補正申請を行った申請書はどうなるのでしょ厚生労働省所管手続に関する補正申請の場合、返戻の対象となった初回申請
うか。
は手続終了扱いを受けるために、明示的な補正期限は設定されません。
補正が必要である旨が、メールで通知される機能はあります
か。
APIにて行われた申請に対しては、メールでの通知は行われません。
補正の有無を確認するには、公文書・コメント一覧取得かコメント通知取得のAPI
を実行する必要があります。
構成管理XMLについて、「申請受け付け番号の初回受付時の記載のとおり初回申請時の到達番号を設定することとなります。
番号」と記載されていますが、補正申請が2回目だった場合、
仮に補正申請が2回目以降であったとしても初回申請時の到達番号とは「新規申
「新規申請時の到達番号」「補正申請1回目の到達番号」のどち請時の到達番号」のみを指します。
らを設定すべきですか。
公文書(コメント通知)取得
公文書はいつのタイミングで送付されるのでしょうか。
1
通常は「審査終了」となった時点で、公文書の取得が可能となります。
但し、審査終了とする処理及び公文書の発行については、各府省の運用次第と
なります。
なお、一つの手続に対し、公文書が複数存在する場合には、
審査終了となったあと全ての公文書が発行されるまでには期間を要する場合が
あります。
2
応答された公文書やコメント通知データのファイル内容はどのよ一例としては下記のようなものです。
うなものでしょうか。
●XMLファイル
鑑文書ファイル。このファイルに電子署名が付与されており、署名検証によって、
改竄の有無の確認ができます。
●XSLファイル
鑑文書を表示するためのスタイルシートファイル。
●添付ファイル(PDFファイルなど)
通知書や証明書など。当該PDFファイルが、郵送による返戻書類（紙）と同等の
扱いとなります。
3
「公文書取得」と「公文書取得完了」、「コメント通知取得」と「コメ「取得」と「完了」はセットで実行する必要があります。
ント通知取得完了」はそれぞれ「取得」と「完了」でAPIが分かれ
ています。
電子化されてはいますが公文書としての位置づけを持つものが発行されるた
「取得」と「完了」はセットで実行する必要があるのでしょうか。
め、当該公文書の発出先（相手方）が「現実に了知しまたは相手方がこれを了知
しうべき状態におかれた時」に初めて相手方に届いたものと認められます（到達
主義。民法97条参照）。
外部連携APIの場合、クライアントがAPIを通じて取得していった公文書等が現実
にクライアント側ハードディスク等に記録されたかどうかは、クライアントによる明
示的な通知を受けなければ、サーバは認識することができず、確実に相手方に
届いたことに関する証跡を得ることができません。
このため、「取得」と「完了」は両方とも実行される必要があります。
4
電子公文書が発行される場合は、「審査終了」の状態になると公文書取得期限を経過後、公文書を取得できなくなります。
思いますが、
その状態で放置した場合にはどのような問題が生じるのでしょう
か。
公文書(コメント通知)取得完了
1
公文書が複数ある場合には、すべての通知通番で完了通知を一つの手続に対して、複数の公文書が存在する場合、全ての公文書を取得する
する必要があるのでしょうか。
ことで手続完了となります。
証明書識別情報
1
利用者IDに紐付く証明書識別情報を一括で取得するAPI機能は存在しておりません。
ありますか。

Download Report