ID Mobile — Rechnungsdokumente mit Zustimmung abrufen

Support DQE
Support DQE
  • Aktualisiert

Verwenden Sie diesen Endpunkt, um mit Zustimmung des Nutzers eine Rechnungsübersicht oder einen Adressnachweis vom Betreiber abzurufen. Der Ablauf umfasst zwei Schritte: die Zustimmungsanfrage initiieren und anschließend das Dokument abrufen.

Verwandte ID-Mobile-Dokumentation:

Schritt 1 — Zustimmungsanfrage initiieren

GET-Anfrage

https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&mode={MODE}&name={NAME}&code_name={CODE_NAME}&licence={LICENCE_CODE}&scope=billing&redirect_uri={URL_REDIRECT}

Ersetzen Sie die Werte in geschweiften Klammern durch Ihre eigenen Informationen:

Parameter Beschreibung Pflicht/Optional
SERVER_ADDRESS Adresse des DQE-Servers, der die Daten verarbeitet. Pflicht
licence Ihnen als Lizenzcode zugewiesene Nummer. Pflicht
number Telefonnummer. Pflicht
token Über die Authentifizierung abgerufenes Token. Pflicht
mode 2: Authentifizierung per Code. Pflicht
name Partnername in der DQE-Software-Datenbank, in der Regel Ihr Firmenname. Pflicht
code_name Optionales Feld mit einem name zugeordneten Code. Optional
scope Statischer Wert. Muss für diesen Scope billing sein. Pflicht
redirect_uri Weiterleitungs-URL. DQE fügt der Weiterleitung das Sitzungstoken und den Status hinzu. Optional

POST-Anfrage

https://{SERVER_ADDRESS}/IDMOBILE/

Fügen Sie die folgenden Parameter im Anfragetext mittels x-www-form-urlencoded hinzu:

Parameter Beschreibung Pflicht/Optional
licence Ihnen als Lizenzcode zugewiesene Nummer. Pflicht
number Telefonnummer. Pflicht
token Über die Authentifizierung abgerufenes Token. Pflicht
mode 2: Authentifizierung per Code. Pflicht
name Partnername in der DQE-Datenbank, in der Regel Ihr Firmenname. Pflicht
code_name Optionales Feld mit einem name zugeordneten Code. Optional
scope Statischer Wert. Muss für diesen Scope billing sein. Pflicht
redirect_uri Weiterleitungs-URL. DQE fügt der Weiterleitung das Sitzungstoken und den Status hinzu. Optional

Antwort

Erfolg

Schlüssel Beschreibung Typ
status success: Informationen wurden erfolgreich abgerufen. STRING
scope billing STRING
billing Adressnachweis in Base64-Kodierung. STRING

Beispiel:

{
  "status": "success",
  "scope": "billing",
  "billing": "N0YXJ0eHJlZgo0OTg2MQolJUVPRgoKLS1ZS0xJNTYpPUlSeFdNUzEoYXJpOWI/UklzLkRXZ1dwUF9FLS0K"
}

Ausstehend

Schlüssel Beschreibung Typ
status pending: DQE wartet auf die Antwort des Betreibers. STRING
scope billing STRING

Beispiel:

{
  "status": "pending",
  "scope": "billing"
}

Fehler

Fehler-ID Fehlertyp Beschreibung
01 invalid request Die Anfrage ist ungültig.
02 invalid licence key Die Lizenz ist ungültig.
04 invalid scope Ungültiger Scope.
18 failed to retrieve data from operator Nach der OTP-Validierung wurden keine Daten empfangen.
20 OTP incorrect Die OTP-Validierung wurde nicht abgeschlossen.
21 access denied Die OTP-Validierung wurde abgelehnt.
30 invalid or expired token Das Token ist abgelaufen.
99 internal server error Serverfehler.

Schritt 2 — Rechnungsdokument abrufen

GET-Anfrage

https://{SERVER_ADDRESS}/GET/?token={TOKEN}&Licence={LICENCE_CODE}&scope=client_idmobile
Parameter Beschreibung Pflicht/Optional
SERVER_ADDRESS Adresse des DQE-Servers, der die Daten verarbeitet. Pflicht
Licence Ihnen als Lizenzcode zugewiesene Nummer. Pflicht
token Über die Authentifizierung abgerufenes Token. Pflicht
scope Statischer Wert. Muss für diesen Scope client_idmobile sein. Pflicht

POST-Anfrage

https://{SERVER_ADDRESS}/GET/

Fügen Sie die folgenden Parameter im Anfragetext mittels x-www-form-urlencoded hinzu:

Parameter Beschreibung Pflicht/Optional
Licence Ihnen als Lizenzcode zugewiesene Nummer. Pflicht
token Über die Authentifizierung abgerufenes Token. Pflicht
scope Statischer Wert. Muss für diesen Scope client_idmobile sein. Pflicht

Antwort

Erfolg

Schlüssel Beschreibung Typ
status success: Dokument wurde erfolgreich abgerufen. STRING
scope billing STRING
billing Adressnachweis in Base64-Kodierung. STRING

Beispiel:

{
  "status": "success",
  "scope": "billing",
  "billing": "N0YXJ0eHJlZgo0OTg2MQolJUVPRgoKLS1ZS0xJNTYpPUlSeFdNUzEoYXJpOWI/UklzLkRXZ1dwUF9FLS0K"
}

Ausstehend

Schlüssel Beschreibung Typ
status pending: DQE wartet auf die Antwort des Betreibers. STRING
scope billing STRING

Fehler

Fehler-ID Fehlertyp Beschreibung
01 invalid request Die Anfrage ist ungültig.
02 invalid licence key Die Lizenz ist ungültig.
04 invalid scope Ungültiger Scope.
18 failed to retrieve data from operator Nach der OTP-Validierung wurden keine Daten empfangen.
20 OTP incorrect Die OTP-Validierung wurde nicht abgeschlossen.
21 access denied Die OTP-Validierung wurde abgelehnt.
30 invalid or expired token Das Token ist abgelaufen.
99 internal server error Serverfehler.

Beispiel:

{
  "status": "error",
  "error_type": "internal server error",
  "error_id": "99"
}

Siehe auch

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich