API & Entwickler-Tools
REST, WebSocket und Webhooks mit OpenAPI 3.1-Spec, interaktiver Konsole und SDKs für JavaScript, Python und PHP – alles öffentlich zugänglich auf developer.educationworks.online.
Die Educationworks-API besteht aus drei Schichten: einer REST-API für synchrone CRUD-Operationen, einem WebSocket-Feed für Echtzeit-Events und einem Webhook-System für asynchrone Benachrichtigungen. Alle drei Schichten teilen dasselbe Authentifizierungsmodell (OAuth 2.0 mit JWT) und denselben Fehlercode-Katalog. Die maschinenlesbare OpenAPI 3.1-Spezifikation können Sie direkt in Ihr Swagger UI oder Stoplight-Studio importieren. Jeder Endpunkt ist mit Rate-Limit-Headern, Idempotency-Keys und einer Sandbox-Umgebung ausgestattet, die echte Produktionsdaten simuliert ohne sie zu berühren.
Alles, was ein professionelles Integrationsprojekt braucht.
Das offizielle educationworks-cli erlaubt lokales Scaffolding, Sandbox-Seeding und automatisierte Migrations-Checks. SDKs für JavaScript (npm), Python (PyPI) und PHP (Packagist) werden bei jeder API-Version automatisch neu generiert und getestet.
Für maschinelle Integrationen steht ein schlankes API-Key-Modell bereit; für nutzerbezogene Flows OAuth 2.0 mit PKCE. Token-Rotation, Scope-Management und Audit-Logs sind im Dashboard ohne zusätzliche Konfiguration verfügbar.
Abonnieren Sie bis zu 50 Event-Typen pro Workspace. Delivery-Retries mit exponential Backoff, signierte Payloads (HMAC-SHA256) und eine Webhook-Debugkonsole im Dashboard machen zuverlässige Event-Verarbeitung zur Routine.
Echtzeit-Statusanzeige unter status.educationworks.online. Das öffentliche Changelog dokumentiert Breaking Changes, neue Features und Deprecations mit semantischer Versionierung. RSS-Feed und E-Mail-Benachrichtigungen halten Ihr Team informiert.
Jede Hauptversion bleibt mindestens 18 Monate nach Erscheinen der Nachfolgeversion aktiv. Breaking Changes werden ausschließlich in neuen Hauptversionen eingeführt und sechs Monate im Voraus angekündigt. Minor- und Patch-Versionen sind immer rückwärtskompatibel.
Im Free-Tarif sind 1.000 Anfragen pro Stunde enthalten. Ab dem Pro-Tarif steigt das Limit auf 50.000 Anfragen pro Stunde. Enterprise-Kunden erhalten angepasste Limits ohne Aufpreis. Alle Limits sind in den Response-Headern X-RateLimit-Limit und X-RateLimit-Remaining sichtbar.
Ja. Jeder Account erhält automatisch eine vollständig isolierte Sandbox, die die Produktions-API spiegelt. Sandbox-Daten werden täglich zurückgesetzt oder können manuell via CLI oder Dashboard geleert werden. Es entstehen keine Kosten für Sandbox-Aufrufe.
Alle Fehlerantworten folgen dem RFC 7807-Standard (Problem Details for HTTP APIs). Jeder Fehler enthält einen maschinenlesbaren type-URI, einen human-readable title und einen detail-String auf Deutsch und Englisch. Der vollständige Fehlerkatalog ist in der Dokumentation verlinkt.
API-Key generieren, Postman-Collection herunterladen und in Minuten den ersten Endpunkt abfragen.
Sandbox-Zugang aktivieren