Einführung : Automated Direct Mail - HelpCenter
Einführung
API - so werden Automatisierungen möglich gemacht
Die optilyz API ist eine RESTful API, die auf vorhersagbare, ressourcenorientierte URLs und HTTP-Response-Codes ausgelegt ist, um erfolgreiche Anfragen oder API-Fehler anzuzeigen.
Authentifizierung
Um sich mit der API zu authentifizieren, müssen Sie entweder Ihren Authentifizierungsschlüssel oder Ihr API-Token im Header jeder Anfrage über HTTP Basic Authentication senden, wobei Sie den Schlüssel als Benutzernamen angeben und das Passwort leer lassen.
Serverseitige API-Anfragen
Wenn Sie bereits API-Zugriff für Ihr Konto aktiviert haben, kann der Authentifizierungsschlüssel auf der Automatisierungs-Seite gefunden werden. Wenn nicht, senden Sie bitte eine E-Mail an support@optilyz.com.
API-Anfragen vom Browser
Hier empfehlen wir die Verwendung der Token-Authentifizierung. Das API-Token kann über die Authentifizierungsmethode der API generiert und für mehrere API-Aufrufe wiederverwendet werden. Jeder generierte Token kann 1 Stunde lang genutzt werden. Mehrere Token können gleichzeitig in Verwendung sein.
Versionierung
Bei Änderungen an der API wird eine neue Version freigegeben. Alle API-Versionen können parallel verwendet werden. Die optilyz API unterstützt die Semver-Versionierung in einem Accept-Version-Header. Wenn in einer Anfrage kein Accept-Version-Header angegeben ist, wird die neueste Version verwendet.
Für rückwärts-inkompatible Änderungen wird eine neue Hauptversion veröffentlicht. Die Hauptversion ist Teil der Endpunkt-URL, z.B. "/api/v1/{}{method}".