Plattform-API
REST-API unter /api/v1 mit Agentur-Schlüssel: Shops, Releases, Themes und Backups.
Die Plattform-API liegt unter https://<plattform>/api/v1. Sie ist für Werkzeuge der Agentur gedacht (CLI, Skripte, Browser-Erweiterung).
#Authentifizierung
Agentur-Schlüssel (plk_…) erstellst du unter Agentur → Sicherheit. Senden als Bearer-Token oder x-api-key:
bash
curl -H "Authorization: Bearer $PLATFORM_API_KEY" https://platform.example.com/api/v1/shopsSchlüssel sind pro Schlüssel ratenbegrenzt. Antworten im Fehlerfall:
json
{ "error": "unauthorized", "message": "API-Schlüssel ungültig oder abgelaufen." }#Endpunkte (Auswahl)
| Methode | Pfad | Zweck |
|---|---|---|
GET | /api/v1/info | Was die CLI zum Anbinden eines Shops braucht |
GET | /api/v1/shops | Alle Shops |
GET / PUT | /api/v1/shops/:id | Shop lesen / anlegen oder aktualisieren (idempotent) |
PATCH | /api/v1/shops/:id | Release (Image-Tag) des Shops eintragen |
GET / POST | /api/v1/themes | Registry lesen / Paket als neue Version hochladen (Body: .zip) |
GET / POST | /api/v1/backups/sources | Backup-Quellen mit Status / neue Quelle (Token) |
POST | /api/v1/backups/requests | Backup oder Wiederherstellungstest anstoßen: { "source", "kind": "backup" | "verify" } |
GET | /api/v1/diagnostics/:shopId | Diagnose-Bericht (auch mit Lesetoken, siehe Diagnose) |
#Vom Shop aufgerufen
Mit dem Callback-Token des Shops (nicht mit Agentur-Schlüssel):
| Pfad | Zweck |
|---|---|
POST /api/v1/shops/:id/errors | Serverfehler eines Dienstes melden |
POST /api/v1/shops/:id/ready | Shop ist bereit |
GET /api/v1/shops/:id/themes | Theme-Katalog für den Shop |
GET / POST /api/v1/shops/:id/payments | Verbundene Zahlungskonten / Stripe oder PayPal verbinden bzw. trennen |
GET /api/v1/shops/:id/themes/:handle/package | Theme-Paket (402 bei Premium ohne Kauf) |
Backup-Container auf Shop-Servern melden mit ihrem Quellen-Token (bks_…) an /api/v1/backups/:source/report und holen Anfragen über /requests/claim.
Zuletzt aktualisiert am 21. Oktober 2026