প্রমাণীকরণ

একটি বিয়ার টোকেন হিসেবে একটি এপিআই কি পাঠান। এই এন্ডপয়েন্টটি স্পেসিফিকেশনে কোনো নির্দিষ্ট অনুমতির কথা বলে না, তাই অনুমান না করে আপনার কি-কে এর জন্য ন্যূনতম প্রয়োজনীয় অনুমতি দিন এবং রেসপন্স পরীক্ষা করুন।

যেখানে আপনার অর্গানাইজেশন আইডি দেওয়া হবে

এই এন্ডপয়েন্টটি org_id-কে একটি কুয়েরি প্যারামিটার হিসেবে গ্রহণ করে। এটি বাদ দিলে কলটি আপনার পুরো টেনেন্সি সাবট্রিকে কভার করে; এটিকে পাঠালে কলটি একটি সংস্থায় সীমাবদ্ধ হয়।

আপনার ড্যাশবোর্ডের API কি স্ক্রিনে, কি-এর ঠিক পাশেই আপনার অর্গানাইজেশন আইডি রয়েছে। আপনি যে কলই করুন না কেন, সবগুলিতেই এই আইডি একই থাকে।

চেষ্টা করুন

কোণ বন্ধনীতে থাকা যেকোনো কিছু আপনার নিজস্ব মান দিয়ে এবং কী প্লেসহোল্ডারটি আপনার ড্যাশবোর্ডের একটি কী দিয়ে প্রতিস্থাপন করুন।

curl -X POST https://api.zinndigital.com/v1/sla/claims \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "monitor_id": <string>, "period_start": <string> }'

লগ ইন করা আছে? আপনার ড্যাশবোর্ডের এপিআই কনসোল আপনার আসল অর্গানাইজেশন আইডি এবং আপনার নিজের কি পূরণ করে দেয়, এবং লাইভ এপিআই-এর বিপরীতে অনুরোধটি চালায় যাতে আপনি প্রকৃত প্রতিক্রিয়া দেখতে পান। এই এন্ডপয়েন্টটি এপিআই কনসোলে খুলুন

বিবরণ

Issues account credit — not cash — as a share of that site's monthly fee, and records it. Idempotent by construction: one month and one monitor may be credited exactly once, enforced by a unique constraint, so a retry, a race and a double click all lose the same way. credit_percent is read only when the month is unadjudicable; a measured month is credited at the tier its own figure reaches and a better one cannot be claimed. Gated on sla.claim.

পরামিতি

নামধরনআবশ্যকএটি কী
org_id (query)stringনাNarrow to one organisation in the caller's subtree — what the dashboard's org switcher sends. ⛔ Narrow only: intersected with what the caller may already write to, so an org…

অনুরোধের বডি

নামধরনআবশ্যকএটি কী
monitor_idstringহ্যাঁ
period_startstringহ্যাঁAny instant in the calendar month being claimed; the month is derived from it.
credit_percentintegerনাThe published tier claimed. Read only when the month is unadjudicable, and refused unless it is one of SlaPolicy.tiers[].credit_percent — a tier is never rounded to the…

প্রতিক্রিয়া

নামধরনআবশ্যকএটি কী
idstringহ্যাঁ
period_startstringহ্যাঁ
credit_percentintegerহ্যাঁ
amount_minorintegerহ্যাঁThe credit in integer minor units of currency (§2.8 — money is never a float).
currencystringহ্যাঁ
outcomestring<measured, unadjudicable>হ্যাঁWhether the month adjudicated, or the credit was granted because our coverage could not decide it.
uptime_percentstringহ্যাঁ
created_atstringহ্যাঁ

এই এন্ডপয়েন্ট থেকে যেসব ত্রুটি আসতে পারে

401 · 403 · 404 · 409 · 422