Echo fejlesztői útmutató

Az Echo API-val a saját rendszereid kezelhetik egy munkaterület feliratkozóit, csoportjait, szegmenseit, mezőit, kampányait, automatizálásait és webhookjait. A webhookok szólnak a rendszereidnek, ha valami történik az Echóban.

Ez az útmutató fejlesztőknek szól. Az ügyféloldalt (tokenek és webhookok létrehozása a felületen) a felhasználói útmutató Integrációk fejezete írja le.

Tartalom

1. Gyors kezdés: base URL, első kérés, kérés- és válaszformátum, lapozás, idempotencia
2. Hitelesítés: API-tokenek, hozzáférési szintek, engedélyezett IP-címek
3. Feliratkozók: listázás, számlálás, felvétel vagy frissítés, olvasás, módosítás, leiratkoztatás, törlés, elfelejtés, tevékenység
4. Csoportok, szegmensek és mezők
5. Importálás API-val: tömeges import egy csoportba és az állapota
6. Kampányok: piszkozatok Custom HTML tartalommal, tesztlevél, időzítés, eredmények
7. Automatizálások: munkafolyamatok, statisztika, futások, aktiválás, szüneteltetés, feliratkozók hozzáadása
8. Webhookok: események, payloadok, aláírás-ellenőrzés, újrapróbálás, célcím-szabályok
9. Kötegelt kérések: legfeljebb 50 kérés egy hívásban
10. Hibák és korlátok: hibaformátum, kódok, sebességkorlát, méretkorlátok

A gépi leírás

A teljes OpenAPI 3.1 dokumentum nyilvános, token nélkül is letölthető:

curl https://echo.uptools.io/public/v1/openapi.yaml

Az útmutató minden példáját egy működő Echo-telepítésen futtattuk, kitalált demóadatokkal. A válaszokban lévő azonosítók, címek és időpontok példák: nálad mások lesznek.