احراز هویت
یک کلید 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