Autentifikacija
Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.
Gdje dolazi ID vaše organizacije
Ova krajnja točka prihvaća org_id kao polje u JSON tijelu.
ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
curl -X POST https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "api_key": <string> }'Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
The key is written to Vault and never to the database. Connecting resets the connection to unverified — a new key behind an old "verified" badge is a connection claiming a proof it does not have.
Tijelo zahtjeva
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
api_key | string | Da | — |
from_local_part | string | Ne | — |
from_display_name | string | Ne | — |
sending_domain | string | Ne | — |
reply_to | string | Ne | — |
org_id | string | Ne | — |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
connected | boolean | Da | — |
id | string | Ne | — |
provider | string | Da | — |
status | string<not_connected, unverified, verified, rejected> | Da | — |
from_address | string | Ne | — |
from_local_part | string | Ne | — |
from_display_name | string | Ne | — |
sending_domain | string | Ne | — |
reply_to | string | Ne | — |
verified_domains | EspVerifiedDomain[] | Ne | — |
last_verified_at | string | Ne | — |
last_error | string | Ne | — |
stats | CampaignDeliveryCounts | Ne | ⛔ `sent` is NOT `delivered`. `sent` means a provider accepted the hand-off; `delivered` means the receiving server accepted it, which arrives later by webhook. A screen showing… |
Pogreške koje ova krajnja točka može vratiti
401 · 403 · 422 · 503