Skip to content
JSON API
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
functions
readme.md

readme.md

Endereco JSON API 3.0

Überblick

Funktion Beschreibung
nameCheck Sucht den Namen in unserer Datenbank und gibt das Geschlecht, sofern bekannt, zurück.
postCodeAutocomplete Gibt mögliche Varianten der PLZ für bestimmte Eingabe aus. Sofern die Stadt bekannt, auch die Stadt.
cityNameAutocomplete Gibt mögliche Varianten der Stadt für bestimmte Eingabe aus. Sofert die PLZ bekannt ist, wird auch die PLZ ausgegeben.
streetAutocomplete Gibt mögliche Varianten der Straße zurück.
addressCheck Prüft eine angegebene Adresse. Gibt Varianten zurück, falls die Adresse nicht eindeutig ist oder es mögliche Berichtigungen gibt.
bankAutocomplete Gibt den Namen und volle Bankleitzahl anhand eines Teils der Bankleitzahl.
bankCodeAutocomplete (neu) Gibt den Namen, volle Bankleitzahl und BIC anhand eines Teils der Bankleitzahl zurück. Neuster Stand.
ibanCheck Prüft die IBAN.
emailCheck Prüft die eMail-Adresse.
prephoneCheck Prüft die Vorwahl oder volle Telefonnummer. Erkennt ob es eine Mobil- oder Festnetznummer ist, gibt die Nummer normalisiert zurück.
doAccounting Markiert eine Transaction zur Abrechnung.
ibanConverter Konvertiert IBAN zu KTO und BLZ oder umgekehrt.

Headers

Folgende Headers müssen bei jeder Anfrage übermittelt werden: Content-Type, X-Auth-Key, X-Transaction-Id, X-Transaction-Referer

Header Bedeutung Beispiel
Content-Type Content type markierung. Soll immer application/json sein. application/json
X-Auth-Key Auth Key. Wird zur Authentifizierung verwendet. Beispiel: a0835c4d0b31b7df976d1153f336d6086b130560e72092808f15b464702ac0fa
X-Transaction-Id Transaction ID. Soll für die aktuelle Session des Clients eindeutig sein und nach doAccounting gelöscht werden. es gibt im Moment keine Vorgabe zum Format. 976d1153f336d6086b130560e
X-Transaction-Referer Angabe von wo aus die Anfragen geschickt werden. z.B. die Unterseite oder eine spezielle Seite in der App https://domain.de/konto-anlegen

Aufbau einer Anfrage

Es wird ein valides JSON erwartet.

Als Basis soll folgende JSON Struktur verwendet werden:

{
  "jsonrpc": "2.0",
  "id": <int>,
  "meta": {
    ...
  }  
  "method": <string>,
  "params": {
    <string>: <string|int>
  }  
}

Bedeutung der Felder:

Feld Typ Bedeutung
jsonrpc string Gibt den Protokol und Version an.
id int Eindeutige Kennung des Request. Kann zum Beispiel ein Counter sein. Man brauch Id um ein Request einem Response zuordnen zu können, was bei Bulk Processing möglicherweise gebraucht werden kann. Man kann Id weglassen, wenn keine Antwort erwartet wird.
meta hash Optionales Feld. Darin können irgendwelche weitere Infos angegeben werden, die bei Antwort wieder zurückgegeben werden.
method string Name der Funktion der Schnittstelle.
params hash Spezifische Parameter. Jede Funktion hat eigene.

Beispiel:

{
  "jsonrpc": "2.0",
  "id": 1,  
  "method": "nameCheck",
  "params": {
    "name": "Robert"
  }  
}

Aufbau einer Antwort (Erfolg)

Es kann ein valides JSON erwartet werden.

Aufbau soll dabei folgender Struktur entsprechen:

{
  "jsonrpc": "2.0",
  "id": <int>,
  "meta": {
    ...
  },
  "result": {
    "status": <array>,
    "payload": <null|array|hash>
  }
}

Bedeutung der Felder:

Feld Typ Bedeutung
jsonrpc string Gibt den Protokol und Version an.
id int Eindeutige Kennung des Request. Kann zum Beispiel ein Counter sein. Man brauch Id um ein Request einem Response zuordnen zu können, was bei Bulk Processing möglicherweise gebraucht werden kann.
meta hash Optionales Feld. Darin können irgendwelche weitere Infos angegeben werden, die bei Antwort wieder zurückgegeben werden.
result.status array Statusmeldungen für das Ergebnis. Sind für jede Funktion spezifisch.
result.payload null array

Beispiel:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "status": ['A1000', 'A1100'],
    "name": "Robert",
    "gender": 'M'
  }
}

Aufbau einer Antwort (Fehler)

Es kann ein valides JSON erwartet werden.

Aufbau soll dabei folgender Struktur entsprechen:

{
  "jsonrpc": "2.0",
  "id": <int>,
  "meta": {
    ...
  } ,
  "error": {
    "code": <int>,
    "message": <string>
  }
}

Bedeutung der Felder:

Feld Typ Bedeutung
jsonrpc string Gibt den Protokol und Version an.
id int Eindeutige Kennung des Request. Kann zum Beispiel ein Counter sein. Man brauch Id um ein Request einem Response zuordnen zu können, was bei Bulk Processing möglicherweise gebraucht werden kann.
meta hash Optionales Feld. Darin können irgendwelche weitere Infos angegeben werden, die bei Antwort wieder zurückgegeben werden.
error.code int Fehlercode.
error.message string Fehlermeldung.

Beispiel:

{
  "jsonrpc": "2.0",
  "id": 1,
  "error": {
    "code": -32700,
    "message": "Fehler beim Parsen der JSON."
  }
}
You can’t perform that action at this time.