Rychlý start

Klíč, první volání, první webhook: víc k zahájení nepotřebujete.

1. Vytvoření klíče

V Apexu otevřete nabídku účtu a zvolte API a webhooky. Klíč může vytvořit Superuživatel účtu nebo Administrátor; právě oni také vidí protokol volání a webhooky. Pokud vývojář klíč sám vytváří a čte protokol, potřebuje v účtu firmy roli Administrátora.

Každá firma má jeden plný testovací a jeden plný ostrý klíč a vedle nich libovolný počet pojmenovaných klíčů pro přehledy, které čtou jen účet a přehledy kampaní a lze je odvolat jednotlivě. Po vytvoření nového ostrého klíče funguje starý ještě 7 dní, poté volání s ním dostanou odpověď 401 api_key_expired: tolik času máte na výměnu. Klíč patří tomu, kdo ho vytvořil, a funguje s jeho přístupem. Pokud tvůrce opustí tým nebo přijde o roli Administrátora, klíč zůstane, ale každé volání dostane odpověď 403 api_key_creator_inactive, dokud ho Superuživatel nebo Administrátor nepřevezme v nabídce API a webhooky; hodnota klíče zůstane stejná.

2. První volání

Ověřte klíč: GET /v1/account ukáže, ke které firmě patří, kdo ho vytvořil a zda běží v ostrém, nebo testovacím režimu (livemode). V ukázkách se klíč bere z proměnné prostředí TRENDIZZ_KEY.

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

3. První webhook

Přidejte koncový bod voláním POST /v1/webhook-endpoints: zadejte vlastní adresu https a požadované typy událostí. Podpisové tajemství (whsec_…) odpověď obsahuje jen jednou, proto si ho uložte. POST /v1/webhook-endpoints/{id}/test odešle testovací událost, takže ověření podpisu si můžete vyzkoušet i s testovacím klíčem.

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