אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את 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 הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-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… |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 422 · 503