Gyorsindítás

Kulcs, első hívás, első webhook: ennyi kell az induláshoz.

1. Kulcs létrehozása

Apexben nyissa meg a fiókmenüt, és válassza az API és webhook pontot. Kulcsot a fiók Szuperfelhasználója vagy egy Adminisztrátora hozhat létre, és a hívásnaplót és a webhookokat is ők látják. Ha a fejlesztő maga hozza létre a kulcsot és nézi a naplót, Adminisztrátor szerep kell neki a cég fiókjában.

Cégenként egy teljes teszt és egy teljes éles kulcs van, mellettük tetszőleges számú, névvel ellátott riportkulcs, amely csak a fiókot és a kampányriportokat olvassa, és egyenként visszavonható. Új éles kulcs létrehozása után a régi még 7 napig működik, utána a vele érkező hívások 401 api_key_expired választ kapnak: ennyi ideje van a cserére. A kulcs a létrehozójához tartozik, és az ő hozzáférésével működik. Ha a létrehozó kikerül a csapatból vagy elveszti az Adminisztrátor szerepét, a kulcs megmarad, de minden hívás 403 api_key_creator_inactive választ kap, amíg a Szuperfelhasználó vagy egy Adminisztrátor át nem veszi az API és webhook pontban; a kulcs értéke ugyanaz marad.

2. Első hívás

Ellenőrizze a kulcsot: a GET /v1/account megmutatja, melyik céghez tartozik, ki hozta létre, és hogy éles vagy teszt módban fut (livemode). A mintákban a kulcs a TRENDIZZ_KEY környezeti változóból jön.

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

3. Első webhook

Vegyen fel egy végpontot a POST /v1/webhook-endpoints hívással: adja meg a saját https címét és a kért eseménytípusokat. Az aláíró titkot (whsec_…) a válasz csak egyszer tartalmazza, ezért mentse el. A POST /v1/webhook-endpoints/{id}/test teszt eseményt küld, így teszt kulccsal is kipróbálhatja az aláírás ellenőrzését.

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"
  }'