共通仕様

通信仕様

HTTP通信

IPv4 （Internet Protocol version 4）またはIPv6 （Internet Protocol version 6）を利用したHTTP 1.1とします。

通信経路

インターネット

通信セキュリティ

TLS（Transport Layer Security）1.2によるサーバ認証、経路暗号化を行います。

※電子申請APIを利用するソフトウェア等へのセキュリティ要求事項

• e-Gov との接続時に、サーバ証明書の検証を行うこと。
  その際、以下の2 点の有効性確認を実施すること。
  • (1)SSL/TLS ライブラリによるサーバ証明書の有効性確認
  • (2)サーバ証明書のコモンネームが、e-Gov 電子申請APIのFQDN名(****.e-gov.go.jp) と一致していることの確認
• 認証・認可情報等、秘密情報を外部に漏洩させない仕様とすること。

API方式

RESTfulなWeb APIとします。
APIエンドポイントに対するリクエストを契機として、HTTPメソッド（GET、POST、PUT等）によるリソース操作を行い、e-Gov電子申請サービスによる処理結果、HTTPステータスコードによりレスポンスします。
エラーとなった場合は、RFC7807準拠のデータ項目を含むエラーレスポンスを行います。

認証・認可方式

OAuth2.0準拠の「認可コードグラント」（Authorization Code Grant）とします。
また、OpenID Connect仕様準拠のOpenID Provider（OP）とのID連携に対応します。

利用可能なアカウント

• e-Govアカウント
• GビズID又はその他OP

利用可能なその他OP

• Microsoft

認可コードグラント

認可コードグラントのシーケンス例について、以下に示します。

• e-Govアカウント

• GビズID及びその他OP

認証・認可API

各トークンの有効期限

クレデンシャル情報及び各トークンの管理

• API利用ソフトウェア等は、APIキー等のクレデンシャル情報及び発行された各トークンを第三者から参照、取得できない安全な領域で管理しなければなりません。
• API利用ソフトウェア等は、不要となったアクセストークンを適切なタイミングで無効化するなど、各トークンの漏洩対策を実施しなければなりません。

メッセージの基本構造

リクエスト及びレスポンスに係るデータ形式については、JSON形式とします。基本的なメッセージ構造を以下に示します。

HTTPヘッダー

クレデンシャル情報やアクセストークン等の認証・認可情報を設定します。

HTTPボディ

APIごとのリクエスト内容や連携する申請データ等のバイナリデータを設定します。

電文で使用する文字コード

UTF-8とします。

データエンコーディング方式

HTTPボディに設定するバイナリデータは、BASE64でテキストデータにエンコード（ RFC4648準拠）した内容を設定します。

エスケープ処理方式

パラメータに以下の文字を設定する場合は、エスケープ処理を行います。
エスケープ文字には（バックスラッシュ）を使用します。

電文のサイズ上限

メッセージ（JSON形式）として１リクエストあたり、ファイルサイズ100Mbyteを上限に受け付けることが可能です。（バイナリデータは、ZIP圧縮後のサイズとなります。）

一括送信時におけるデータのサイズ上限

bulk送信系のAPIにおいて、1回のリクエストで送受信可能なデータサイズは、100Mbyteを上限に受け付けることが可能です。（100Mbyte以内であれば、件数の制限はありません。）

一覧取得可能なデータ件数

一覧取得系のAPIにおいて、1回のリクエストで送受信可能なデータ件数は、50件を上限とします。

日付形式

年月日　　　：YYYY-MM-DD 　　 例：2020-01-01
年月日時分秒：YYYY-MM-DD HH:MM:SS　　例：2020-01-01 21:30:00

URIの基本構造

アドレスを指定可能とします

英語名詞（可算名詞の場合は複数形）を使用し、複数のアドレス指定可能なURIとします。
1つのリソースに対してアドレス指定可能なURIを用意することを原則とします。

URI例：https://WebApiFQDN/v1/apply/lists/12345

複数の単語を連結する場合

複数の単語を連結する場合は、「-（ハイフン）」を利用して単語間を連結するケバブケースとし、すべて小文字とします。

https://WebApiFQDN/v1/user-address/12345

リクエストパラメータ名の場合は、「_（アンダーバー）」を利用して単語間を連結するスネークケースとし、すべて小文字とします。

URI例：https://WebApiFQDN/v1/apply/lists/12345?user_id=1000

バージョン情報を含む

URIにはバージョン情報を含むようにし、メジャーバージョンによるバージョニングを行います。
バージョン番号は 「v」+「整数」(v1、v2等）で表記し、バージョン番号を小数にしません。

URI例：https://WebApiFQDN/v1/apply/lists/12345

FQDN

APIエンドポイントに係るFQDNは、各APIで共通とします。

キーとなる番号

• 申請データ送信等により送信された申請データのうち、形式チェック等の結果、e-Govに到達したものに対して到達番号を付与します。到達以降の処理状況等については、到達番号をキーとして確認可能とします。
• 申請データbulk送信により送信されたbulkデータについては、識別用の整理番号として送信番号を付与します。送信後のe-Gov電子申請サービスにおける処理結果については、送信番号をキーとして確認可能とします。なお、bulk送信とは非同期に実行する形式チェック等の結果、特段のエラーを検出しなかった申請データについては、それぞれに到達番号を付与します。
• 到達番号を持つ申請案件に対する提出先行政機関からの通知については、それぞれに通知通番を付与しており、当該番号と到達番号の組合せにより、通知情報を取得可能です。なお、通知通番自体は、一覧取得APIのレスポンスとして取得できるようにしています。
• 行政手続所管府省による案内については、お知らせIDを付与しており、当該IDをキーとして手続に関する案内情報を取得可能とします。なお、お知らせID自体は、一覧取得APIのレスポンスとして取得できるようにしています。

その他

• APIエンドポイントへの接続に当たっては、API利用ソフトウェア開発事業者に発行するソフトウェアID及びAPIキーによるAPIクライアント認証を行います。
• e-Govで受け付けたリクエストについては、同時並列処理を行います。
• リクエストの着信順に処理を実行しますが、負荷分散構成のサーバによる同時並列実行となるため、各リクエストの処理順序については保証しません。