Kimlik Doğrulama
Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.
Kurum kimliğinizin yazılacağı yer
Bu uç nokta, JSON gövdesinde bir alan olarak org_id alır.
Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X POST https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "api_key": <string> }'Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
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.
İstek gövdesi
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
api_key | string | Evet | — |
from_local_part | string | Hayır | — |
from_display_name | string | Hayır | — |
sending_domain | string | Hayır | — |
reply_to | string | Hayır | — |
org_id | string | Hayır | — |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
connected | boolean | Evet | — |
id | string | Hayır | — |
provider | string | Evet | — |
status | string<not_connected, unverified, verified, rejected> | Evet | — |
from_address | string | Hayır | — |
from_local_part | string | Hayır | — |
from_display_name | string | Hayır | — |
sending_domain | string | Hayır | — |
reply_to | string | Hayır | — |
verified_domains | EspVerifiedDomain[] | Hayır | — |
last_verified_at | string | Hayır | — |
last_error | string | Hayır | — |
stats | CampaignDeliveryCounts | Hayır | ⛔ `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 uç noktanın dönderebileceği hatalar
401 · 403 · 422 · 503