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

Test / Produktiv System

Für die Entwicklung und Testumsetzung ist ein Test-System verfügbar. Die Funktionalitä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 das Test sowie Produktivsystem weichen voneinander ab.

Umstellung von Test auf Produktivsystem

Da beide Systeme dieselben Funktionalitäten bieten, sind bei der Umstellung nach erfolgreichen Tests i.d.R.  nur folgende Parameter anzupassen:

• API URL
• Zugangsdaten (Benutzername,Passwort)
• Tarifzuweisungen

Http-HTTP-Header

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

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/