Zum Hauptinhalt springen
Dieser Artikel beschreibt eine Identitätsinformationen und Gültigkeitsprüfung API Integrationsanleitung, die zur Überprüfung der Echtheit und Konsistenz von Namen, Personalausweisnummer und Gültigkeitsdauer des Personalausweises verwendet werden kann.

​
Antragsprozess

Um die API zu nutzen, müssen Sie zunächst auf die entsprechende Seite der Identitätsinformationen und Gültigkeitsprüfung API gehen und den entsprechenden Dienst beantragen. Nachdem Sie die Seite betreten haben, klicken Sie auf die Schaltfläche „Acquire“, wie im Bild gezeigt: Wenn Sie noch nicht angemeldet oder registriert sind, werden Sie automatisch zur Anmeldeseite weitergeleitet, um sich zu registrieren und anzumelden. Nach der Anmeldung werden Sie automatisch zur aktuellen Seite zurückgeleitet. Bei der ersten Beantragung gibt es ein kostenloses Kontingent, mit dem Sie die API kostenlos nutzen können.

​
Grundlegende Nutzung

Zunächst sollten Sie die grundlegende Nutzung verstehen, indem Sie den Link zum Bild des Personalausweises eingeben, um die verarbeiteten Überprüfungsergebnisse zu erhalten. Zuerst müssen Sie einfach ein name-Feld übermitteln, das Sie dann im Interface ausfüllen können, wie im Bild gezeigt:

Hier haben wir die Request-Header festgelegt, einschließlich:
  • accept: In welchem Format Sie die Antwort erhalten möchten, hier eingetragen als application/json, also im JSON-Format.
  • authorization: Der Schlüssel zur Nutzung der API, den Sie nach der Beantragung direkt auswählen können.
Außerdem haben wir den Request-Body festgelegt, einschließlich:
  • name: Name.
  • id_card: Personalausweisnummer.
  • image_url: Link zum Bild des Gesichts, das verarbeitet werden soll.
  • validity_end: Ablaufdatum des Personalausweises, Format: YYYYMMDD, für langfristig „00000000“ verwenden;
  • validity_begin: Beginn der Gültigkeit des Personalausweises, Format: YYYYMMDD.
  • encryption: Optional, Parameter zur Verschlüsselung sensibler Felder (falls verschlüsselte Daten gesendet werden müssen).
Nach der Auswahl können Sie auf der rechten Seite den entsprechenden Code sehen, wie im Bild gezeigt:

Klicken Sie auf die Schaltfläche „Try“, um einen Test durchzuführen, wie im obigen Bild gezeigt, hier haben wir folgendes Ergebnis erhalten: 
{
  "result": "0",
  "description": "Konsistent"
}
Die Rückgabe hat mehrere Felder, die wie folgt beschrieben werden:
  • result, der Authentifizierungsergebniscode, die Gebühren sind wie folgt.
    • Gebührenergebniscode:
      • 0: Name und Personalausweisnummer stimmen überein
      • -1: Name und Personalausweisnummer stimmen nicht überein
    • Gebührenfreie Ergebniscodes:
      • -2: Ungültige Personalausweisnummer (Länge, Prüfziffer usw. nicht korrekt)
      • -3: Ungültiger Name (Länge, Format usw. nicht korrekt)
      • -4: Dienst des Dokumentenarchivs fehlerhaft
      • -5: Keine Aufzeichnung dieser Personalausweisnummer im Dokumentenarchiv
      • -6: Autorisiertes Vergleichssystem wird aktualisiert, bitte später erneut versuchen
      • -7: Anzahl der Authentifizierungen hat das Tageslimit überschritten.
  • description, hier das Ergebnis der Überprüfung von Name und Personalausweisnummer.
Es ist zu erkennen, dass Name, Personalausweisnummer und Gültigkeitsdauer im Personalausweis Echtheit und Konsistenz aufweisen. Wenn Sie den entsprechenden Integrationscode generieren möchten, können Sie ihn direkt kopieren, zum Beispiel ist der CURL-Code wie folgt: 
curl -X POST 'https://api.acedata.cloud/identity/idcard/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "id_card": "***",
  "validity_begin": "***",
  "validity_end": "***"
}'
Der Integrationscode in Python sieht wie folgt aus: 
import requests

url = "https://api.acedata.cloud/identity/idcard/check-2e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "name": "***",
    "id_card": "***",
    "validity_begin": "***",
    "validity_end": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​
Fehlerbehandlung

Wenn beim Aufruf der API ein Fehler auftritt, gibt die API den entsprechenden Fehlercode und die Informationen zurück. Zum Beispiel:
  • 400 token_mismatched: Ungültige Anfrage, möglicherweise aufgrund fehlender oder ungültiger Parameter.
  • 400 api_not_implemented: Ungültige Anfrage, möglicherweise aufgrund fehlender oder ungültiger Parameter.
  • 401 invalid_token: Unbefugt, ungültiger oder fehlender Autorisierungstoken.
  • 429 too_many_requests: Zu viele Anfragen, Sie haben das Rate-Limit überschritten.
  • 500 api_error: Interner Serverfehler, etwas ist auf dem Server schiefgelaufen.

​
Beispiel für eine Fehlerantwort

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "Abruf fehlgeschlagen"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Fazit

Durch dieses Dokument haben Sie gelernt, wie Sie die Identitätsinformationen und Gültigkeitsprüfung API verwenden, um die Echtheit und Konsistenz von Namen, Personalausweisnummer und Gültigkeitsdauer zu überprüfen. Wir hoffen, dass dieses Dokument Ihnen hilft, die API besser zu integrieren und zu nutzen. Bei Fragen wenden Sie sich bitte jederzeit an unser technisches Support-Team.