Technische Dokumentation

Die Content API hinter testsieger.shopping

Diese Schnittstelle versorgt Redaktions- und Importprozesse mit strukturierten Schreib- und Lesezugriffen fuer Sections, Kategorien, Produkte und Bildimporte. Der Fokus liegt auf kontrollierten Mutationen, klaren Schemas und reproduzierbaren Importablaeufen.

GET, POST, PATCH, DELETE

Sections

/api/content/sections

Verwaltet die oberste redaktionelle Ebene. Loeschen ist blockiert, solange Kategorien darunter existieren.

GET, POST, PATCH, DELETE

Kategorien

/api/content/categories

Liefert oder aktualisiert Kategorie-Dokumente inklusive SEO- und Sortierfeldern. Einzelabrufe koennen eine schlanke Produktliste enthalten.

GET, POST, PATCH, DELETE

Produkte

/api/content/products

Pflegt die eigentlichen Ranking-Objekte. Einzelabrufe koennen Testresultate und Affiliate-Angebote einbeziehen.

GET

Meta

/api/content/meta

Beschreibt Schemas, Regeln, Rate Limits und Beispiel-Payloads. Das ist der schnellste Einstieg fuer Clients und Automationen.

POST

Bildimport

/api/content/products/{slug}/images

Laedt Originalbilder per HTTPS-Quelle in Storage und schreibt die resultierenden Media-Felder synchron in das Produktdokument.

Wie die API eingesetzt wird

  1. 1Client authentifiziert sich mit Authorization: Bearer {IMPORT_SECRET}.
  2. 2Client liest optional /api/content/meta, um erlaubte Felder und Regeln vor dem Schreiben zu kennen.
  3. 3Neue Sections, Kategorien und Produkte werden ueber die jeweiligen Collection-Routen angelegt.
  4. 4Bildmaterial wird separat ueber den Images-Endpunkt importiert, damit die Produktdokumente nur echte Storage-Daten referenzieren.
  5. 5Schreibzugriffe sind pro IP auf 20 Requests pro Minute begrenzt; Lesezugriffe sind nicht rate-limitiert.

Wichtige Regeln

  • Slugs sind nach dem Anlegen unveraenderlich.
  • Create-Requests setzen published serverseitig auf false.
  • Bildquellen muessen HTTPS und Alt-Texte enthalten.
  • Fehlercodes 401, 404, 409, 422, 429 und 500 sind explizit definiert.
  • Der Meta-Endpunkt liefert Schemas und Beispielpayloads fuer Clients.

Beispiel: Einstieg ueber den Meta-Endpunkt

Ein Client kann zuerst die selbstbeschreibende Metadaten-Route lesen, um verfuegbare Ressourcen, Schemas und serverseitige Regeln zu verstehen, bevor Schreibzugriffe ausgefuehrt werden.

curl -H "Authorization: Bearer $IMPORT_SECRET" \
  https://testsieger.shopping/api/content/meta