共通仕様

通信仕様

HTTP通信

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

通信経路

インターネット

通信セキュリティ

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

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

API方式

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

認証・認可方式

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

利用可能なアカウント

利用可能なその他OP

認可コードグラント

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

シーケンス例 e-Govアカウント
GビズID及びその他OP

認証・認可API

API 概要
ユーザ認可 レスポンスとして、認証画面・同意画面が返却されます。
認証・同意の確認後、指定されたURLにリダイレクトされます。
アクセストークン取得 アクセストークンを取得します。
アクセストークン検証 取得したアクセストークン、またはリフレッシュトークンの有効性の検証を行います。
アクセストークン再取得 アクセストークンが無効となった場合、リフレッシュトークンによるアクセストークンの再取得を行います。
ログアウト 取得したアクセストークンを無効化します。

各トークンの有効期限

トークン 有効期限
アクセストークン、IDトークン 60分 (3,600秒)
リフレッシュトークン 180日 (15,552,000秒)

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

メッセージの基本構造

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

メッセージ構造

HTTPヘッダー

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

HTTPボディ

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

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

UTF-8とします。

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

HTTPボディに設定するバイナリデータは、BASE64でテキストデータにエンコード( RFC4648準拠)した内容を設定します。
BASE64エンコーディングにおける仕様として、1行の最大長は64桁とします。

エスケープ処理方式

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

対象文字 エスケープ表記
" (ダブルコーテーション) \"
\ (バックスラッシュ) \\
/ (スラッシュ) \/
\n (改行) \\n

電文のサイズ上限

メッセージ(JSON形式)として1リクエストあたり、ファイルサイズ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で共通とします。

キーとなる番号

その他