# 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 `<span class="n">http</span>`-Protkoll und Port `<span class="mi">443</span>`

## Sicherheit und Freigaben

Sämtliche Kommunikation erfolgt ü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: `<span class="n">http</span>`
- Port: `<span class="mi">443</span>`
- DNS Namen / A-Record: `<span class="n">kunden</span><span class="o">-</span><span class="n">systeme</span><span class="o">-</span><span class="mi">384614943</span><span class="p">.</span><span class="n">eu</span><span class="o">-</span><span class="n">central</span><span class="o">-</span><span class="mi">1</span><span class="p">.</span><span class="n">elb</span><span class="p">.</span><span class="n">amazonaws</span><span class="p">.</span><span class="n">com</span>`

## 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/](https://dev-api.meldescheine.de/api/)   
Web-Frontend: [https://dev.meldescheine.de/](https://dev.meldescheine.de/)

##### Produktiv-System:

API-Backend: [https://api.meldescheine.de/api/ ](https://api.meldescheine.de/api/)  
Web-Frontend: [https://v2.meldescheine.de/](https://v2.meldescheine.de/)

<p class="callout warning">Zugangsdaten für das Test sowie Produktivsystem weichen voneinander ab.</p>

## 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-Header

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

<table border="1" id="bkmrk-name-wert-beschreibu" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 25%;">**Name**</td><td style="width: 25%;">**Wert**</td><td style="width: 25%;">**Beschreibung**</td></tr><tr><td style="width: 25%;">Content-Type</td><td style="width: 25%;">application/json oder application/xml </td><td style="width: 25%;">Inhalt der Anfrage, entsprechend JSON oder XML</td></tr><tr><td style="width: 25%;">User-Agent</td><td style="width: 25%;">beliebige Zeichenkette</td><td style="width: 25%;">Eine beliebige Zeichenkette - im Idealfall übergeben Sie hier einen eindeutigen Bezeichner Ihres Systems z.B "mustermann-booking-1.0.4-x86"</td></tr></tbody></table>

<p class="callout info">Wenn die o.g. Header nicht übergeben werden, so werden Ihre Anfragen mit einem HTTP Error Code `403 "forbidden"` abgelehnt.</p>

## URL Endung

Alle Aufrufe einer URL sollten mit einem abschliessenden Slash (`<span class="o">/</span>`) erfolgen.

Nicht korrekt:

<table class="codehilitetable" id="bkmrk-token-erzeugen-post-"><tbody><tr><td class="code"><div>```
 <span class="n">Token</span> <span class="n">erzeugen</span>
 <span class="n">POST</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">api</span><span class="p">.</span><span class="n">meldescheine</span><span class="p">.</span><span class="n">de</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="n">token</span>
```

</div></td></tr></tbody></table>

Korrekt:

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