Markus Michalski FAQ

Contact Requests: Admin-API

Sylius Contact Requests Plugin - REST-API mit Admin-Anmeldung zum Auslesen gespeicherter Kontaktanfragen: Endpunkte, Beispielanfrage, Fehlerformat

English Version

Zurück zur Übersicht

Contact Requests: Admin-API

Live Demo: Teste dieses und weitere Plugins live — ohne Installation, ohne Risiko: demo.markus-michalski.net

Keine öffentliche Shop API. Gespeicherte Kontaktanfragen enthalten personenbezogene Daten. Das Plugin stellt sie deshalb nur über eine API mit Admin-Anmeldung bereit, nicht über eine öffentliche Shop API, wie es bei Plugins mit sichtbaren Storefront-Funktionen üblich ist.

Endpunkte

Methode Pfad Beschreibung
GET /api/v2/admin/contact-requests Liste aller gespeicherten Anfragen, neueste zuerst
GET /api/v2/admin/contact-requests/{id} Eine einzelne Anfrage

Beide Endpunkte verlangen ROLE_API_ACCESS, dieselbe Berechtigung wie jede andere Admin-API-Ressource von Sylius. Die Anmeldung läuft über das reguläre Admin-API-Token (POST /api/v2/admin/administrators/token).

Beispielanfrage

curl -H "Authorization: Bearer $ADMIN_API_TOKEN" \
     https://shop.example.com/api/v2/admin/contact-requests

Beispielantwort (gekürzt, im Hydra-Format von API Platform):

{
  "member": [
    {
      "id": 42,
      "createdAt": "2026-10-09T08:15:00+00:00",
      "name": "Jane Doe",
      "email": "jane@example.com",
      "subject": "Frage zur Lieferzeit",
      "message": "...",
      "consent": true
    }
  ],
  "totalItems": 1
}

Fehlerformat

Es gilt das Standard-Fehlerformat von API Platform (Hydra/Problem Details). Ein fehlendes oder falsches Token ergibt 401, ein Token ohne ROLE_API_ACCESS ergibt 403, eine unbekannte id ergibt 404. Das JSON hat dabei dieselbe Form wie bei jeder anderen Admin-API-Ressource von Sylius.