Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Където отива идентификаторът на вашата организация
Този краен пункт приема org_id като поле в JSON тялото.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X POST https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "api_key": <string> }'Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
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.
Тяло на заявката
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
api_key | string | Да | — |
from_local_part | string | Не | — |
from_display_name | string | Не | — |
sending_domain | string | Не | — |
reply_to | string | Не | — |
org_id | string | Не | — |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
connected | boolean | Да | — |
id | string | Не | — |
provider | string | Да | — |
status | string<not_connected, unverified, verified, rejected> | Да | — |
from_address | string | Не | — |
from_local_part | string | Не | — |
from_display_name | string | Не | — |
sending_domain | string | Не | — |
reply_to | string | Не | — |
verified_domains | EspVerifiedDomain[] | Не | — |
last_verified_at | string | Не | — |
last_error | string | Не | — |
stats | CampaignDeliveryCounts | Не | ⛔ `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… |
Грешки, които този крайpoint може да върне
401 · 403 · 422 · 503