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-AdresseTest / Produktiv System
Für die Entwicklung und Testumsetzung ist ein Test-System verfügbar. Die Basis-URLFunktionalität beider Systeme ist diesselbe - im Testsystem können jedoch bereits Features enthalten sein, welche noch nicht im Produktivsystem vorhanden sind.
Testsystem:
API-Backend: https://dev-api.meldescheine.de/api/
Web-Frontend: https://dev.meldescheine.de/
Produktiv-System:
API-Backend: https://api.meldescheine.de/api/
Web-Frontend: https://v2.meldescheine.de/
Zugangsdaten für alledas aufrufeTest lautet:sowie Produktivsystem weichen voneinander ab.
Umstellung Systeme
von Test beide auf Da |
- API URL
- Zugangsdaten (Benutzername,Passwort)
- Tarifzuweisungen
Http-Header
Für die korrekte Übergabe im System sind folgende Http-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" |
Wenn die o.g. Header nicht übergeben werden, so werden Ihre Anfragen mit einem HTTP Error Code 403 "forbidden" abgelehnt
URL Endung
Alle Aufrufe einer URL sollten mit einem abschliessenden Slash (/
) erfolgen.
Nicht korrekt:
Token erzeugen POST https://api.meldescheine.de/api/token |
Korrekt:
Token erzeugen
POST https://api.meldescheine.de/api/token/