API

Alles per API – ohne Anmeldung

Mit einem Zugriffstoken richtest du neue Websites komplett per HTTP ein: Website anlegen, Banner konfigurieren, veröffentlichen, Einbau-Schnipsel holen. Lesende Tokens rufen Statistik und Nachweise ab.

Zwei Arten von Tokens

Im Konto erzeugst du ein Token und wählst sein Recht. Das Token steht im Authorization-Header; es wird nur einmal angezeigt, gespeichert ist bei uns nur ein Hash.

  • „nur lesen“: Websites, Entwürfe, Fassungen, Statistik, Nachweise und Cookie-Tabelle abrufen
  • „lesen und ändern“: zusätzlich Websites anlegen und umbenennen, Entwürfe speichern, veröffentlichen und alte Fassungen wiederherstellen
  • Gültigkeit beim Anlegen: 30 Tage, 90 Tage, ein Jahr oder ohne Ablauf; bis zu zehn Tokens je Konto, jederzeit widerrufbar

Eine neue Website in vier Schritten

Website anlegen, Entwurf holen und anpassen, speichern, veröffentlichen. Die Antwort beim Anlegen enthält den Einbau-Schnipsel. Vorlagen für Dienste und die festen Regeln liefert /api/service-templates.

TOKEN="kp_…"; API=https://kekspopup.com/api
curl -X POST $API/sites -H "Authorization: Bearer $TOKEN" -H "X-Keks: 1"      -H "Content-Type: application/json" -d '{"name":"Shop","domain":"shop.beispiel.de"}'
curl $API/sites/12 -H "Authorization: Bearer $TOKEN"            # Entwurf unter "draft"
curl -X PUT $API/sites/12/draft -H "Authorization: Bearer $TOKEN" -H "X-Keks: 1"      -H "Content-Type: application/json" -d @entwurf.json
curl -X POST $API/sites/12/publish -H "Authorization: Bearer $TOKEN" -H "X-Keks: 1"      -H "Content-Type: application/json" -d '{"note":"per API"}'

Was nur im Browser geht

Auch ein Token mit Schreibrecht kann kein Abo buchen oder kündigen, keine Tokens anlegen, das Konto nicht löschen und keine Website löschen – mit einer Website gingen ihre Einwilligungsnachweise verloren. Die Bestätigung für Google Consent Mode „Advanced“ gibt ebenfalls nur ein Mensch im Browser ab.

Für Tokens gelten dieselben Regeln wie im Editor: feste Beschriftungen der Hauptknöpfe, nicht überschreibbare Hinweiszeile, Mindestkontraste. Ein Entwurf, der sie verletzt, wird mit einer Fehlermeldung abgelehnt.

Tokens sind von der Zwei-Faktor-Anmeldung ausgenommen. Gib Tokens mit Schreibrecht deshalb eine Gültigkeit und bewahre sie wie ein Passwort auf.

Häufige Fragen

Brauche ich für die API eine Anmeldung?

Nur einmal, um das Token zu erzeugen. Danach arbeitet dein Programm allein mit dem Token.

Gibt es Webhooks?

Nein.

In welchem Tarif ist die API enthalten?

In jedem, auch im kostenlosen.

Ist die Schnittstelle dokumentiert?

Die Wege stehen auf dieser Seite. Den Aufbau eines Entwurfs siehst du am einfachsten in der Antwort von GET /api/sites/<id> unter „draft“.

Mehr über kekspopup

Banner einrichten

Website anlegen, Dienste auswählen, eine Zeile einbauen.

Mit Google anmelden