Authentifizierung

Zur Verwendung der API musst du dich mit einem API-Key authentifizieren. Dazu wird HTTP Basic Authentication verwendet. Der API-Key ist als Benutzernamen einzugeben. Ein Passwort ist nicht erforderlich.

Der Host für alle APIs lautet: http://api.opendata.host/

vat-id

Bietet Operationen zum Suchen und Verifizieren von UIDs.

Unterstützte reg-no-class Werte:

• at-fb - Österreichisches Firmenbuch

vat-id/validate

Überprüft ob die angegebene UID-Nummer gültig und vorhanden ist. Wenn die UID-Nummer gefunden wurde, wird sie mit Daten aus unserer Datenbank (Firmenname, Firmenbuchnummer) angereichert und zurückgegeben.

 

URL:

http://api.opendata.host/1.0/vat-id/validate?vat-id=xxx

Beispiel:

http://api.opendata.host/1.0/vat-id/validate?vat-id=ATU15107505

 

Parameter

vat-id

UID die verifiziert werden soll

Resultat

Erfolg

/1.0/vat-id/validate?vat-id=ATU15107505
{
   reg-no: "92117t",
   reg-no-class: "at-fb",

   name: "Compass-Datenbank GmbH",
   size: 1,
   errorCode: 0
}

Fehler

/1.0/vat-id/validate?vat-id=ATU99907505
{
   size: 0,
   errorCode: 1,
   errorMessage: "No results found"
}

vat-id/find

Findet UID-Nummern anhand von übergebenen Parametern (Firmenbuchnummer).

URL:

http://api.opendata.host/1.0/vat-id/find?reg-no=xxx&reg-no-class=xxx&limit=xxx&offset=xxx

Beispiel:

http://api.opendata.host/1.0/vat-id/find?reg-no=92117t&reg-no-class=at-fb&limit=&offset=0

 

Parameter

reg-no	Identifikation für den ausgewählten Typen
reg-no-class	Typ der Identifikation, default at-fb (Österreichisches Firmenbuch)
limit	Anzahl der maximal angezeigten Ergebnisse, default 100
offset	Index des Startelements, default 0

Resultat

 

Erfolg

/1.0/vat-id/find?reg-no=92117t&reg-no-class=at-fb&limit=&offset=0
{
   vat-ids:  [
      "ATU15107505"
   ],
   offset:  0,
   limit:  1,
   size: 1,
   errorCode:  0
}

Fehler

/1.0/vat-id/find?reg-no=92117t&reg-no-class=de-fb
{
   size:  0,
   errorCode:  1,
   errorMessage:  "No results found"
}

Fehlercodes

Folgende Fehlercodes werden verwendet:

Errorcode	Fehlergrund	Errormessage
0	Erfolg	keine Message
1	Keine Resultate gefunden	No results found
2	Keine Daten bei Compass gefunden	No data available
3	Eingabeparameter entsprechen nicht dem erwarteten Format (z.B. Firmennummer)	Invalid input format
4	Suche zu allgemein	Please narrow your search conditions
5	Unerwarteter Fehler	Internal error