Doğrulama
API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.
Təşkilatınızın identifikatorunun yerləşdiyi yer
Bu son nöqtə JSON gövdəsində sahə kimi org_id qəbul edir.
Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X POST https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "api_key": <string> }'Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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.
Sorğu gövdəsi
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
api_key | string | Bəli | — |
from_local_part | string | Xeyr | — |
from_display_name | string | Xeyr | — |
sending_domain | string | Xeyr | — |
reply_to | string | Xeyr | — |
org_id | string | Xeyr | — |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
connected | boolean | Bəli | — |
id | string | Xeyr | — |
provider | string | Bəli | — |
status | string<not_connected, unverified, verified, rejected> | Bəli | — |
from_address | string | Xeyr | — |
from_local_part | string | Xeyr | — |
from_display_name | string | Xeyr | — |
sending_domain | string | Xeyr | — |
reply_to | string | Xeyr | — |
verified_domains | EspVerifiedDomain[] | Xeyr | — |
last_verified_at | string | Xeyr | — |
last_error | string | Xeyr | — |
stats | CampaignDeliveryCounts | Xeyr | ⛔ `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… |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 422 · 503