Autentificare
Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.
Unde merge ID-ul organizației tale
Acest punct final preia org_id ca câmp în corpul JSON.
ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X POST https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "api_key": <string> }'Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
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.
Corp cerere
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
api_key | string | Da | — |
from_local_part | string | Nu | — |
from_display_name | string | Nu | — |
sending_domain | string | Nu | — |
reply_to | string | Nu | — |
org_id | string | Nu | — |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
connected | boolean | Da | — |
id | string | Nu | — |
provider | string | Da | — |
status | string<not_connected, unverified, verified, rejected> | Da | — |
from_address | string | Nu | — |
from_local_part | string | Nu | — |
from_display_name | string | Nu | — |
sending_domain | string | Nu | — |
reply_to | string | Nu | — |
verified_domains | EspVerifiedDomain[] | Nu | — |
last_verified_at | string | Nu | — |
last_error | string | Nu | — |
stats | CampaignDeliveryCounts | Nu | ⛔ `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… |
Erori pe care le poate returna acest punct final
401 · 403 · 422 · 503