API und Webhooks für Entwickler
Programmatischer Zugriff auf den Workspace: API-Schlüssel, Event-Webhooks und das Entwicklerportal.
Das Entwicklerportal (Developer Portal) – alles für die Integration von Oprela mit Ihren Systemen.
Wo zu finden
Einstellungen (Settings) → API & Webhooks (…/developers).
API-Schlüssel
- API-Schlüssel erstellen (Create API key) → Name und Berechtigungen (Lesen/Schreiben, welche Ressourcen).
- Der Schlüssel wird nur einmal angezeigt – speichern Sie ihn in einem Geheimnis-Manager.
- Verwenden Sie ihn im Header von API-Anfragen; die Dokumentation der Endpunkte finden Sie auf derselben Seite.
Webhooks
Abonnieren Sie Ihre URL für Ereignisse: neue Bestellung, Statusänderung, neuer Kunde. Jedes Ereignis ist ein POST mit JSON. Lieferprotokolle und Wiederholungen – ebenfalls dort. Marketing-Ereignisse – separat: Marketing-Webhooks.
Sicherheit
- Bewahren Sie Schlüssel außerhalb des Codes auf (Umgebungsvariablen);
- Beschränken Sie die Schlüsselberechtigungen auf ein Minimum;
- Bei Kompromittierung – löschen Sie den Schlüssel und erstellen Sie einen neuen.