Allgemein

Die Anwendung verfügt über eine Programmierbare Schnittstelle, kurz API (Application Programming Interface) genannt. Mithilfe dieser ist es möglich Informationen zwischen der Anwendung und Drittanbietern auszutauschen.

Protokoll

Die Kommunikation erfolgt ausschließlich über das http-Protkoll und Port 443

Sicherheit und Freigaben

Sämtliche Kommunikation erfolget über HTTPS mit einem SHA-256 RSA verschlüsselten SSL Zertifikat Sollte Ihr System hinter einer Firewall installiert sein, werden folgende Freigaben benötigt.

Protokoll: http
Port: 443
DNS Namen / A-Record: kunden-systeme-384614943.eu-central-1.elb.amazonaws.com

Basis-Adresse

Die Basis-URL für alle aufrufe lautet:

 https://api.meldescheine.de/

Notwendige Header

Für die korrekte Übergabe im System sind folgende Header zwingend notwendig

Name	Wert	Beschreibung
Content-Type	application/json oder application/xml	Inhalt der Anfrage, entsprechend JSON oder XML
User-Agent	beliebige Zeichenkette	Eine beliebige Zeichenkette - im Idealfall übergeben Sie hier einen eindeutigen Bezeichner Ihres Systems z.B "mustermann-booking-1.0.4-x86"

URL Endung

Alle Aufrufe einer URL sollten mit einem abschliessenen Slash (/) erfolgen.

Nicht korrekt:

 Token erzeugen
 POST https://api.meldescheine.de/api/token

Korrekt:

 Token erzeugen
 POST https://api.meldescheine.de/api/token/