Einführung in den Ablauf und die öffentlichen Materialien für allgemeine Softwareentwickler zur Entwicklung von Softwarediensten mithilfe der externen Verknüpfungs-API von e-Gov.
Allgemeine Softwareentwickler usw. (im Folgenden als Entwicklungsunternehmen bezeichnet) müssen die Softwareentwicklung bei e-Gov (Ministerium für innere Angelegenheiten und Kommunikation) beantragen.
① Beantragen Sie die Softwareentwicklung ② Dokumente im Zusammenhang mit dem Antrag auf Verwendung der Verifizierungsumgebung werden von e-Gov gesendet ③ Der Entwickler füllt die erforderlichen Elemente (Benutzer-ID usw.) aus und sendet die Anwendungsanwendung für die Verifizierungsumgebung an e-Gov. ④ e-Gov sendet Materialien zur Verifizierungsumgebung ⑤ Entwickler entwickelt Software-Service ⑥ Der Entwickler beantragt den endgültigen Bestätigungstest ⑦ Der Entwickler übermittelt das endgültige Bestätigungstestergebnis ⑧ Der Softwaredienst wird durch ein Urteil von e-Gov verfügbar
In ③ beschreibt der Entwickler die folgenden Inhalte im Anwendungsformular für die Verifizierungsumgebung.
No | Inhalte, die in der Überprüfungsumgebung ausgefüllt werden sollen, verwenden das Antragsformular |
---|---|
1 | Name der Unternehmensorganisation |
2 | Name der Software |
3 | Benutzer-ID (bis zu 3 Personen können sich bewerben) |
4 | Geben Sie mit 〇 die externe Verknüpfungs-API an, die in der Überprüfungsumgebung verwendet werden soll. Benutzer-ID-Registrierung, Benutzerauthentifizierung und Stapelanwendung sind erforderlich. |
Bei ④ sendet Ihnen e-Gov Materialien zur Verifizierungsumgebung. Entwickler müssen diese Informationen streng kontrollieren.
No | Dokumente zur Verifizierungsumgebung |
---|---|
1 | Hinweis zur Verwendung der Überprüfungsumgebung (URL der Überprüfungsumgebung, Software-ID, Benutzer-ID, grundlegende Authentifizierungs-ID und Kennwort) |
2 | Dateninformationen für den API-Test (Testdaten für die Erfassungs-API für Korrekturbenachrichtigungslisten, Teilkorrektur-API, Korrekturwiederholungs-API, die nur von der Software-ID verwendet werden kann) |
3 | Abschließender Bestätigungstest Testspezifikationen und Bericht |
Die URL der Überprüfungsumgebung ist eine andere Anforderungs-URL als die Produktionsumgebung. Zu diesem Zeitpunkt wird die in der Anwendungsanwendung für die Verifizierungsumgebung beschriebene Benutzer-ID in e-Gov registriert, und die folgenden Zertifikate werden in Verbindung mit dieser Benutzer-ID verwaltet.
Zertifikatstatus | Name der Zertifikatsdatei |
---|---|
Wirksamkeit | e-GovEE01_sha2.pfx |
Abgelaufen | e-GovEE04_sha2.pfx |
Abgelaufen | e-GovEE05_sha2.pfx |
Sie können die für Entwickler von e-Gov vorbereiteten Materialien herunterladen. Hier finden Sie Gebrauchsanweisungen, Begriffe, Antragsformulare, Spezifikationen, elektronische Zertifikate zum Testen der Verifizierungsumgebung usw.
No | Gebrauchsanweisung, Antragsformular usw. |
---|---|
1 | API-API-Übersicht für externe Verknüpfungen |
2 | Anwendungshandbuch für die API für externe Verknüpfungen |
3 | Externe Kooperations-API verschiedene Antragsformulare (festgelegt) |
4 | Nutzungsbedingungen der externen Kooperations-API |
5 | Externe Verknüpfungs-API Umgang mit persönlichen Informationen |
No | Spezifikationen, Definition der XML-Struktur des Antragsformulars |
---|---|
1 | Spezifikationen der externen Verknüpfungs-API-API (Version 1) |
2 | Externe Verknüpfungs-API Spezifikationen für Informationssicherheitsanforderungen |
3 | Externe Verknüpfung API Anwendungsdatenspezifikationen Allgemeine Datenspezifikationen |
4 | Liste der anwendbaren Verfahren |
5 | Liste der Verfahrensinformationen / Liste der Übermittlungsziele (festgelegt) |
6 | Antragsformular Definition der XML-Struktur Sozialversicherungsverfahren |
7 | Antragsformular Definition der XML-Struktur Arbeitsversicherungsbezogene Verfahren |
8 | Definition der XML-Struktur des Antragsformulars Verfahren im Zusammenhang mit der Sammlung von Anträgen auf Arbeitsversicherungen |
No | Testverfahren für die Überprüfungsumgebung |
---|---|
1 | Liste der API-Testverfahren |
2 | Liste der API-Testverfahren (angehängte Statusübergangsliste für API-Testverfahren) |
3 | Definition der XML-Struktur des Antragsformulars [API-Testverfahren] |
No | Digitales Zertifikat für den Test der Verifizierungsumgebung |
---|---|
1 | Elektronisches Zertifikat |
Hier werden die Spezifikationen, Testverfahren für die Verifizierungsumgebung und elektronische Zertifikate vorgestellt.
Beschreibt die Spezifikationen für den Anforderungs-URI und seine Parameter für die Erstellung einer elektronischen Anwendung unter Verwendung der API, das im http-Anforderungshauptteil angegebene Übertragungs-XML und den von e-Gov zurückgegebenen Antworttext (Antwort-XML).
Es beschreibt die Sicherheitsanforderungen, die Entwickler bei der Entwicklung von Software erfüllen müssen.
Die allen Verfahren gemeinsamen Datenspezifikationen und die individuellen Spezifikationen für jedes Verfahren werden beschrieben. XML-Tag-Strukturen werden für Konfigurationsmanagement-XML, Konfigurationsinformations-XML und Anwendungs-XML definiert.
Individuelle Spezifikationen bezüglich der Anwendungsdaten für jedes Verfahren werden beschrieben.
Dies ist eine öffentliche Spezifikation bezüglich des Testverfahrens, das beim Testen in Bezug auf die externe Verknüpfungs-API in der Verifizierungsumgebung verwendet werden kann.
No | Definition der XML-Struktur des Antragsformulars [API-Testverfahren] |
---|---|
1 | Liste der API-Testverfahren |
2 | Liste der API-Testverfahren (angehängte Statusübergangsliste für API-Testverfahren) |
3 | Definition der XML-Struktur des Antragsformulars [API-Testverfahren] |
In der "Liste der API-Testverfahren" können Sie den folgenden Inhalt für das Testverfahren überprüfen.
――Das Antragsformular für jedes Verfahren ist so strukturiert, dass es die Testfälle abdeckt, die für Tests im Zusammenhang mit der API erforderlich sind, und die entsprechenden Verfahrensinformationen werden festgelegt und verwaltet.
In der Liste "API-Testverfahren (angehängte Statusübergangsliste für API-Testverfahren)" können Sie den automatischen Statusübergang überprüfen. Die folgenden zwei Beispiele werden vorgestellt.
In diesem Abschnitt wird die SHA-256-Version des in der Überprüfungsumgebung verwendeten digitalen Zertifikats beschrieben.
No | Dateiname | Erläuterung |
---|---|---|
1 | e-GovEE01_sha2.pfx | Eine gültige Zertifikatvoreinstellung für die Benutzer-ID |
2 | e-GovEE02_sha2.pfx | Gültiges Zertifikat |
3 | e-GovEE03_sha2.pfx | Gültiges Zertifikat |
4 | e-GovEE04-1_sha2.pfx | Abgelaufene Zertifikatsvoreinstellung für Benutzer-ID |
5 | e-GovEE04-2_sha2.pfx | Gültiges Zertifikat |
6 | e-GovEE05_sha2.pfx | Abgelaufene Zertifikatsvoreinstellung für Benutzer-ID |
Das digitale Zertifikatsuffix repräsentiert das Format des Zertifikats. ".Pfx" ist ein PKCS # 12 (PFX) -Format für Schlüssel und Zertifikate, mit dem der Serverschlüssel zusammen mit der gesamten Zertifikatkette gespeichert und geschützt werden kann. Dieses Format wird häufig in Microsoft-Produkten verwendet.
Überprüfen Sie den Inhalt des Zertifikats mit dem Befehl openssl. Wenn Sie unterwegs nach einem Passwort gefragt werden, geben Sie "gpkitest" ein.
Ausführungsergebnis von openssl
>openssl pkcs12 -info -in e-GovEE01_sha2.pfx
Enter Import Password:(Geben Sie "gpkitest" ein)
MAC Iteration 2000
MAC verified OK
PKCS7 Data
Shrouded Keybag: pbeWithSHA1And3-KeyTripleDES-CBC, Iteration 2000
Bag Attributes
localKeyID: 01 00 00 00
friendlyName: le-d39d0281-d8cb-4396-b002-b4366119c8e4
Microsoft CSP Name: Microsoft Enhanced Cryptographic Provider v1.0
Key Attributes
X509v3 Key Usage: 10
Enter PEM pass phrase:
Verifying - Enter PEM pass phrase:
-----BEGIN ENCRYPTED PRIVATE KEY-----
MIIFDjBABgkqhkiG9w0BBQ0wMzAbBgkqhkiG9w0BBQwwDgQITLitdILmV8cCAggA
MBQGCCqGSIb3DQMHBAiXSoB8We54iwSCBMiWf80URxShHlnQltb0fsWst7cAZF2D
/FnXM/8RRrMuK561dB5f+7ImMTtJobdOYOEpeO8sqxhGGeEnivFPMhvrsdGKMZul
nCoQBk0ug0iG2vnlQZAP6RPhbo9u4H3ZtTxJeO4DnYdJJj681vxlkEwhQ+Xv7arV
ZkDAmP20E3tKsobuIKNoLDF6HvrsW6k3bSeYcQqjm71BUAZe9DR2JnBNilbnN7gn
NXtsl8B2bGj8/bATsF37elW/zRkm+35vhcV4jLOEJY67ZF9uVAmSgjGXDuEo3pWO
jrX3t5ErsDXXObjw35cVVTvXUZl6s98p2QC3D/hThUf+MBE+pjO3AnNdb0Pjikmf
Fx1VSaeRW1vpf6/oOdwBUGPJuUXyZm1t93/AiYMOG5r9UFLRoFoHKYeCUte+BO2o
N6M2wUSgekzQejrZeT6ATvRpA15yQ6laAFw6LwPRbJ3zykCch2UAPJaspXgUzdfA
9jGzGuq9xIOgeVe+Gi2OdLBk+hAc0qF+zkrwuhswWT3vSSNQ2/mlfl3kI7MPzcvB
82mzC0aPCts8oG0JVL3m/WpnfO6XFnB5GRB10mo7NyiecjHOEPCfsjOcsTr/Bl1N
EPkh4Rt+o315l4UFtIw8nfK8xiw9ag6Lc8n3IUy9+fUWe/MmZxsvKfMyUe8x8RJA
gubv1R8RUqPg+rq6rCydlPE3RlMwro5ooF5sblWANPpNJwyTOr1CEJHTyWzzdMnz
pdbVj0Tz9P3YvR9+KUmv5FPO+Ke/G0KLVbvg14OUfTr5xFEihUrYPOWtRlGlGOyT
le+rGFAzIsRTJvFU6RGsktGTXyzmPBxY2YPuTnDnkdUCLl8UIcXUPMeWRSIh5YC0
zpPgwLlDdy0dnDSIYo5j2yjhYCYcx0MkkZpkn896RcFkK/QnX5L+EvCz6GIZVxAi
yEzD6lFs4Uamm7E/6MbfyoxxbfIOq8BKoufhSbu/QzUlVw/f1+HXjROaTjB2zRuo
GmuWMugdhEMkKl1R4MTpIhoORdQNYGRWcJfbvSZx6gAmTDMoYkt5h05+haNyXY3t
VkLIlHnpRcQR+JgFghyp0j49kmgyKjRZ6XyCgRnUazE9GOalCZLRZuFQEIlgjNRQ
i5f+LI1UNULxD3PJR8A6AMXiasfk94t4qlpH5xc2HVC44Hrk/gX9vfIYBodw43qX
/r0Z2H/27Qte0IRAZ3jzBV46wN2Y0fqKVQNFchIIJleSebd/ka317ICI8gphf+Js
7Y//jUfl03X7oB2GviVHNzvtjJy0AgAlHkltEgswSbWmd3e+lsCtRpnpe4f1qj76
nYTy0AYtvcZwsE7EaCDYGz/KGQVJjorKVgK12N27catPUcDX3NPMhv9YVe1rcVhT
Iku2X6b0c+YmDSGs05m0LUp8HMN/RUAVg+77atjBT72yqABzV2OcZDc9vHCZfYg2
hO/NSfITPB/Jun/gd4VgjH8sO9Eupa/DgZKQ7b858Md6kjK37iKu8cxvG9VfizFj
/msgnKpZmB0lXnvb7hQUgbeOXC0HP1VswZqq1JBzvFICcFo+4KZQquig2SJytR5o
bFxOWp1zXMllQWSunt1aMnmun/B68BU6SiNXNjnTn+gAd+i3avys8X1VLZBFAwKF
6wY=
-----END ENCRYPTED PRIVATE KEY-----
PKCS7 Encrypted data: pbeWithSHA1And40BitRC2-CBC, Iteration 2000
Certificate bag
Bag Attributes
localKeyID: 01 00 00 00
subject=/C=JP/O=DemoMin1/OU=CA1/CN=Ichiro Madoguchi
issuer=/C=JP/O=DemoMin1/OU=CA1
-----BEGIN CERTIFICATE-----
MIIEizCCA3OgAwIBAgIEWCsMRzANBgkqhkiG9w0BAQsFADAuMQswCQYDVQQGEwJK
UDERMA8GA1UECgwIRGVtb01pbjExDDAKBgNVBAsMA0NBMTAeFw0xOTEwMjUwMTE2
NTZaFw0yNDEwMjQxNDU5NTlaMEkxCzAJBgNVBAYTAkpQMREwDwYDVQQKDAhEZW1v
TWluMTEMMAoGA1UECwwDQ0ExMRkwFwYDVQQDDBBJY2hpcm8gTWFkb2d1Y2hpMIIB
IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsD81VFFmGM26HYdeGrGzbPba
deBzU4WxIE1r6qeZLxjz7DiV42tjo8QFulWZk6hmCeb5j9ChKp+BA/9Yj6usccKH
ZrPQmbcXUZkXRXz9z/7CLxp8b1zAzJakZ0g7o9iU3a3TpyeP6V+GFtkO8YqfthEs
JsYzx82dUi85Bm4l5pnztozPdXRZd2VJpdwzGqtqw6N9PKzMNWux5C0jklkaPeP5
P6NHLfeN51+phkY2xkdJlry629PeKjZAwN0Z8Xu0JdubCvA95UctoZgBoOjpgDtW
ImV3o9hDpwu+1tMlEBhNZIuKOr2G38qRZ9iJUyoK+XhbzyBUu0A2cwCj0MshbwID
AQABo4IBlDCCAZAwDgYDVR0PAQH/BAQDAgbAMBEGCWCGSAGG+EIBAQQEAwIGQDBO
BgNVHRIERzBFpEMwQTELMAkGA1UEBhMCSlAxHjAcBgNVBAoMFeaooeaTrOawkemW
k+iqjeiovOWxgDESMBAGA1UECwwJ77yj77yh77yRMB8GA1UdIAEB/wQVMBMwEQYP
AoM4ho4xCAEBAAKMmyVkMGgGA1UdEQRhMF+kXTBbMQswCQYDVQQGEwJKUDEeMBwG
A1UECgwV5qih5pOs5rCR6ZaT6KqN6Ki85bGAMRIwEAYDVQQLDAnvvKPvvKHvvJEx
GDAWBgNVBAMMD+eqk+WPo+OAgOS4gOmDjjBQBgNVHR8ESTBHMEWgQ6BBpD8wPTEL
MAkGA1UEBhMCSlAxETAPBgNVBAoMCERlbW9NaW4xMQwwCgYDVQQLDANDQTExDTAL
BgNVBAMMBENSTDEwHwYDVR0jBBgwFoAUFNPnlvRSx8XFOnRlLumW95h4I18wHQYD
VR0OBBYEFD6UH9Exye9dEpz9MHJ3sbUDpoZSMA0GCSqGSIb3DQEBCwUAA4IBAQBb
CKyFGsqMv6+HkrY0OK+4v40PJQAa/KbOC3JTKooLfNCNXTiTwtWAl1sGN+Ow8pIp
8Yvj16VcYpi8zO4TmNe8NT+u/e2OvBXwJ9OxOs9UNI2m/mXGcSSJ7eXMR3aVCniD
U7IaQeicquQttLP9IOk9Ao1W+BM35y5bITA/BMO5tzgaimp4G484QtF/XLi40rGh
aZAHGEfvl0abJXPumjajhnGv7SCkjw4+9qdz5Dtp6kl+GVshQgo6ofpEWhVzdhfq
KhNy8dNRL7C/gOTYm+M9SAFk9syL5xKXRyMUGDOheypiJrW/QyOjrxs6cFa5VqaZ
WcRIq8yVPwABCpGG/hjU
-----END CERTIFICATE-----
――Der Teil, der von "----- BEGIN ENCRYPTED PRIVATE KEY -----" bis "----- END ENCRYPTED PRIVATE KEY -----" eingeschlossen ist, ist der private Schlüssel. --Der Teil, der von "----- BEGIN CERTIFICATE -----" bis "----- END CERTIFICATE -----" umgeben ist, ist das Zertifikat (öffentlicher Schlüssel).
In e-Gov verwaltet der Softwareentwickler drei Zertifikate, indem er sie mit der Benutzer-ID verknüpft, die bei der Beantragung der Verifizierungsumgebung gewünscht wird. Beim Testen werden normalerweise gültige Zertifikate verwendet. Darüber hinaus werden das abgelaufene Zertifikat und das widerrufene Zertifikat im Test verwendet, um das von e-Gov verwaltete Zertifikat zu erneuern.
Zertifikatstatus | Name der Zertifikatsdatei |
---|---|
Wirksamkeit | e-GovEE01_sha2.pfx |
Abgelaufen | e-GovEE04_sha2.pfx |
Abgelaufen | e-GovEE05_sha2.pfx |
Vergewissern Sie sich für den endgültigen Bestätigungstest, dass das Senden / Empfangen von Daten zwischen dem Softwaredienst und e-Gov gemäß den e-Gov-Spezifikationen erfolgreich ist. Die Funktion des Softwaredienstes als Anwendung wird nicht bestätigt.
Die SmartHR-Bibliothek kiji verwendet RSpec, um den endgültigen Bestätigungstest zu automatisieren.
No | API-Name | Bedingungen zur Bestätigung | HTTP-Antwortcode |
---|---|---|---|
1 | Registrierung der Benutzer-ID | Geben Sie die hinzuzufügende Benutzer-ID an | "201"Sein |
2 | Benutzerauthentifizierung | e-Geben Sie die in Gov registrierte Benutzer-ID an | "200"Sein |
3 | Massenanwendung | Geben Sie die Stapelanwendungsdatei an | "202"Sein |
4 | Listeninformationen abrufen(ID-Spezifikation) | Geben Sie die Übertragungsnummer zum Zeitpunkt der Stapelanwendung an | "200"Sein |
5 | Listeninformationen abrufen(Datum angeben) | Geben Sie den Akquisitionszielzeitraum an | "200"Sein |
6 | Erfassung von Informationen zur Anwendungsliste | Geben Sie die Übertragungsnummer zum Zeitpunkt der Stapelanwendung an | "200"Sein |
7 | Statusabfrage | Geben Sie die Ankunftsnummer an, die Sie durch Abrufen der Informationen zur Anwendungsliste erhalten haben | "200"Sein |
8 | Rückzug | Geben Sie die Abhebungsdaten der Ankunftsnummer an, die abgehoben werden können | "200"Sein |
9 | Liste der Korrekturbenachrichtigungen abrufen | Geben Sie eine korrigierbare Ankunftsnummer für Statusanfragen an | "200"Sein |
10 | Korrektur(erneut einreichen) | Korrektur(erneut einreichen)Geben Sie eine mögliche Ankunftsnummer an | "202"Sein |
11 | Korrektur(Teilkorrektur) | Korrektur(Teilkorrektur)Geben Sie eine mögliche Ankunftsnummer an | "202"Sein |
12 | Korrektur(Änderungsantrag) | Korrektur(Änderungsantrag)Geben Sie eine mögliche Ankunftsnummer an | "202"Sein |
13 | Holen Sie sich eine Liste der offiziellen Dokumente und Kommentare | Geben Sie die Ankunftsnummer an, unter der die offizielle Dokumentnachricht der Statusabfrage festgelegt ist | "200"Sein |
14 | Offizielle Dokumente erhalten | Geben Sie das offizielle Dokument der Benachrichtigungsnummer innerhalb der Erwerbsfrist an | "200"Sein |
15 | Offizielle Dokumentenerfassung abgeschlossen | Geben Sie das offizielle Dokument an, das Sie durch den Erwerb des offiziellen Dokuments erhalten haben | "200"Sein |
16 | Überprüfung der Unterschrift des offiziellen Dokuments | Geben Sie das offizielle Dokument an, das Sie durch den Erwerb des offiziellen Dokuments erhalten haben | "200"Sein |
17 | Kommentarbenachrichtigung erhalten | Geben Sie innerhalb der Erwerbsfrist eine Kommentarbenachrichtigung über die Benachrichtigungsnummer an | "200"Sein |
18 | Erfassung der Kommentarbenachrichtigung abgeschlossen | Geben Sie die durch Benachrichtigung erfasste Kommentarbenachrichtigung an | "200"Sein |
19 | Erhalten Sie eine Liste von Finanzinstituten, die elektronische Zahlungen unterstützen | - | "200"Sein |
20 | Erhalten Sie eine elektronische Zahlungsinformationsliste | Geben Sie die zahlbare Ankunftsnummer an | "200"Sein |
21 | Fügen Sie Informationen zur Zertifikatsidentifikation hinzu | Geben Sie das Zertifikat an, das neu registriert werden soll | "200"Sein |
22 | Aktualisierung der Zertifikatsidentifikationsinformationen | Geben Sie das zu erneuernde Zertifikat an | "200"Sein |
23 | Informationen zur Zertifikatsidentifikation löschen | Geben Sie das zu löschende Zertifikat an | "200"Sein |
Recommended Posts