ページの本文へ

仕様書ダウンロード

外部連携API仕様書等一覧

外部連携API API概要

詳細情報を開く

外部連携APIの概要、APIの一覧及び各APIの機能概要について説明した資料です。

外部連携API 利用ガイド更新日:2015年12月21日

詳細情報を開く

外部連携APIを利用するソフトウェア開発を行う際の申込みからe-Gov本番環境における外部連携API利用ソフトウェアの使用開始に至るまでの流れと手順の詳細について説明した資料です。
この資料には、以下の内容が記載されています。

  • 外部連携API利用ソフトウェア開発の申込み
  • 外部連携API利用ソフトウェアの開発
  • 検証環境の利用申込み
  • 検証環境での動作確認
  • 最終確認試験の申込み
  • 最終確認試験の実施
  • 最終確認試験結果の提出
  • 外部連携API利用ソフトウェアの利用開始
  • 留意事項

外部連携API API(Version 1)仕様書更新日:2015年12月21日

詳細情報を開く

各APIの仕様について詳細に説明した資料です。この資料には以下の内容が記載されています。

  • 各APIのリクエストURL
  • 各APIのURLパラメータ
  • 各APIの送信パラメータ(HTTPヘッダー部及びボディ部)
  • 各APIの応答結果XMLの構造仕様
  • 各APIのHTTPステータスコード
  • 各APIのメッセージ定義、コード定義
  • 申請データと到達番号の対応付けに関する説明
  • 検証環境利用時の留意事項等
  • 別紙1 メッセージ一覧
  • 別紙2 外部連携APIコードリファレンス

外部連携API 情報セキュリティ要求仕様書更新日:2015年2月19日

詳細情報を開く

外部連携APIを利用するソフトウェアによる実装を要する情報セキュリティ対策に関する要求仕様について説明した資料です。

外部連携API 申請データ仕様共通データ仕様書更新日:2015年6月24日

詳細情報を開く

e-Gov電子申請システムにおける一括申請データ、取下げデータ、補正データの構造及び形式に関する共通仕様について説明した資料です。また、以下の資料を含みます。

  • 別紙1 構成管理XMLの構造定義
    構成管理XMLの構造定義について説明した資料です。
  • 別紙2 申請書に対する構成情報の構造定義
    申請書に対する構成情報の構造定義について説明した資料です。
  • 別紙3 添付書類に対する構成情報の構造定義
    添付書類に対する構成情報の構造定義について説明した資料です。
  • 別紙4 取下げに関する申請書XMLの構造定義
    取下げに関する申請書XMLの構造定義について説明した資料です。
  • スキーマファイル
    構成管理XML及び各構成情報の基本構造を記述したファイルです。

対象手続一覧更新日:2016年7月14日

詳細情報を開く

仕様を公開している手続について一覧で説明した資料です。(一括申請に係る公開仕様と同じもの)

手続情報一覧/提出先一覧(一式)更新日:2016年7月14日

詳細情報を開く

仕様を公開している手続及び提出先について説明した資料です。また、以下の資料を含みます。(一括申請に係る公開仕様と同じもの)

  • 手続情報一覧(PDF,CSV)
  • 提出先一覧(PDF,CSV)

申請書XML構造定義【社会保険関係手続】(一式)更新日:2016年7月14日

詳細情報を開く

社会保険に関連する各手続の申請書XML構造定義について説明した資料です。(一括申請に係る公開仕様と同じもの)

申請書XML構造定義【労働保険関係手続】(一式)更新日:2015年9月29日

詳細情報を開く

労働保険に関連する各手続の申請書XML構造定義について説明した資料です。(一括申請に係る公開仕様と同じもの)

申請書XML構造定義【労働保険適用徴収関係手続】(一式)更新日:2016年4月11日

詳細情報を開く

労働保険適用徴収に関連する各手続の申請書XML構造定義について説明した資料です。(一括申請に係る公開仕様と同じもの)

外部連携API 各種申込書(一式)更新日:2015年7月24日

詳細情報を開く

外部連携APIを利用するソフトウェア開発を行うための申込書と記入要領を説明した資料です。また、以下の内容を含みます。

  • 外部連携API利用ソフトウェア開発申込書
  • 最終確認試験申込書
  • 利用者ID削除申込書
  • ソフトウェアID削除申込書
  • 事業者情報変更届

外部連携API 利用規約

詳細情報を開く

外部連携APIを利用するソフトウェアの開発者が外部連携APIを利用する際の諸条件を定めた文書です。

外部連携API 個人情報の取扱について

詳細情報を開く

外部連携APIを利用するソフトウェア開発を行う際の総務省における個人情報の取扱方針を定めた文書です。

検証環境テスト用手続更新日:2015年12月21日

詳細情報を開く

検証環境において外部連携APIに係るテストを行う際に利用できるテスト用手続に関する公開仕様です。

検証環境テスト用電子証明書更新日:2015年03月27日

詳細情報を開く

検証環境におけるテストの際に使用する電子証明書です。以下の内容を含みます。

  • SHA-256版

政府認証基盤テスト環境の変更にともない、3月27日13時00分以降外部連携APIのテストを実施する際は、SHA-256版のテスト用証明書を御使用ください。 3月26日までテスト用証明書として提供していたminA.testEE-gov.p12、minC.testEE-gov.p12及びSHA-1版のテスト用証明書は、テストを行う際には使用できませんので御注意ください。