Schnellstart

Schlüssel, erster Aufruf, erster Webhook: Mehr brauchen Sie für den Einstieg nicht.

1. Schlüssel erstellen

Öffnen Sie in Apex das Kontomenü und wählen Sie API und Webhooks. Einen Schlüssel kann der Superuser des Kontos oder ein Administrator erstellen, und nur diese sehen auch das Aufrufprotokoll und die Webhooks. Erstellt die Entwicklerin oder der Entwickler den Schlüssel selbst und liest das Protokoll, ist die Rolle Administrator im Firmenkonto nötig.

Pro Firma gibt es einen Testschlüssel und einen Live-Schlüssel mit vollem Zugriff, dazu beliebig viele benannte Berichtsschlüssel, die nur das Konto und die Kampagnenberichte lesen und einzeln widerrufen werden können. Nachdem ein neuer Live-Schlüssel erstellt wurde, funktioniert der alte noch 7 Tage lang; danach erhalten Aufrufe mit ihm 401 api_key_expired. So lange haben Sie Zeit für den Wechsel. Ein Schlüssel gehört seiner Erstellerin oder seinem Ersteller und arbeitet mit deren bzw. dessen Zugriffsrechten. Verlässt diese Person das Team oder verliert sie die Rolle Administrator, bleibt der Schlüssel bestehen, aber jeder Aufruf erhält 403 api_key_creator_inactive, bis der Superuser oder ein Administrator ihn unter API und Webhooks übernimmt; der Wert des Schlüssels bleibt derselbe.

2. Erster Aufruf

Prüfen Sie den Schlüssel: GET /v1/account zeigt, zu welcher Firma er gehört, wer ihn erstellt hat und ob er live oder im Testmodus läuft (livemode). In den Beispielen stammt der Schlüssel aus der Umgebungsvariable TRENDIZZ_KEY.

curl "https://api.trendizz.com/v1/account" \
  -H "Authorization: Bearer $TRENDIZZ_KEY"

3. Erster Webhook

Legen Sie mit POST /v1/webhook-endpoints einen Endpunkt an: Geben Sie Ihre eigene https-Adresse und die gewünschten Ereignistypen an. Das Signaturgeheimnis (whsec_…) enthält die Antwort nur einmal, speichern Sie es deshalb. POST /v1/webhook-endpoints/{id}/test sendet ein Testereignis, sodass Sie die Signaturprüfung auch mit einem Testschlüssel ausprobieren können.

curl -X POST "https://api.trendizz.com/v1/webhook-endpoints" \
  -H "Authorization: Bearer $TRENDIZZ_KEY" \
  -H "Idempotency-Key: my-request-1" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://crm.acme.example/hooks/trendizz",
    "events": [
      "positive_response.created",
      "suppression.created"
    ],
    "description": "CRM sync"
  }'