API-Schnittstelle

Inhalt

Vorbemerkungen

Authentifizierung

Fehlermeldungen

API-Endpoints

Third-Party-Libraries

Support

Wir bieten eine Schnittstelle zum Abholen der auf unserer Seite generierter Rechtstexte an. Damit können Sie unseren Dienst mit Ihrer Webseite verbinden und Änderungen an Rechtstexten automatisch einpflegen. Diese Seite richtet sich an Softwareentwickler.

Vorbemerkungen

Wir empfehlen, die bei uns abgeholten Rechtstexte in Ihren Systemen zwischenzuspeichern und nur in Intervallen nach neuen Versionen zu prüfen. Dies schützt Sie zum einen davor, dass sie Ihren Besuchern keine Rechtstexte anzeigen können, wenn unser Dienst einmal nicht verfügbar sein sollte. Zum anderen wird die Ladezeit Ihrer Seiten, auf denen Sie unsere Rechtstexte einbinden, deutlich erhöht, da ein weiterer Round-Trip für Ihre Besucher wegfällt.

Unsere API gibt Daten im JSON-Format zurück, XML-Responses werden nicht unterstützt. Allen Requests sollten einen Accept-Header Accept: application/json enthalten. Alle Aufrufe müssen über HTTPS erfolgen.

Unsere API ist unter https://www.einfach-abmahnsicher.de/api/v1 erreichbar. Der letzte Teil gibt die Versionsnummer der API an. Es können jederzeit Änderungen an der API vorgenommen werden. Breaking-Changes werden jedoch unter neuer Versionsnummer angeboten.

Authentifizierung

Zur Authentifizierung ist die Generierung eines Access-Tokens notwendig. Diesen können Sie sich im Profil generieren. Die Authentifizierung erfolgt über den HTTP-Header:

Fehlermeldungen

Wir geben bei Fehlermeldungen die gängigen HTTP-Status-Codes zurück. Codes im 2xx-Bereich zeigen eine erfolgreiche Antwort an, Codes im 4xx-Bereich eine Fehler auf Client-Seite (bspw. falsche Authentifizierung, falscher Syntax etc.), und Codes im 5xx-Bereich einen Serverfehler. In einem solchen Fall, melden Sie sich bitte an den Support.

API-Endpoints

Im Folgenden finden Sie ein Liste mit unseren API-Endpoints.

GET/api/v1/pages
Eine Übersicht über alle hinterlegten Webseiten.

GET/api/v1/pages/{hash}
Eine Übersicht generierter Rechtstexte einer hinterlegten Webseite. Ist ein Rechtstext nicht generiert, wird null zurückgegeben

GET/api/v1/pages/{hash}/imprint
Generiertes Impressum sowie ggf. Änderungen. Wenn der Rechtstext aktuell ist, ist changes leer. Gibt es Änderungen an dem Rechtstext, werden die Änderungen dort aufgelistet. Änderungen werden nicht automatisch übernommen sondern müssen explizit übernommen werden (s. nächstes Beispiel).

PUT/api/v1/pages/{hash}/imprint
Übernahme aller vorgeschlagenen Änderungen.

GET/api/v1/pages/{hash}/privacy-policy
Generiertes Datenschutzerklärung sowie ggf. Änderungen.