billing

POST `/v1/sla/claims`

Claim the service credit for one monitored site's month.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც bearer token. ეს ენდპოინტი სპეციფიკაციაში არ მიუთითებს კონკრეტულ ნებართვას, ამიტომ მიანიჭეთ თქვენს გასაღებს მინიმალური საჭირო უფლებები და ვარაუდის ნაცვლად შეამოწმეთ პასუხი.

სwhere your organisation id goes-ის ადგილი

ეს ენდპოინტი იყენებს პარამეტრად org_id. მისი გამოტოვების შემთხვევაში ზარი ფარავს თქვენი იჯარის მთელ ქვეხეს, ხოლო გაგზავნისას ზარი შეიზღუდება მხოლოდ ერთ ორგანიზაციამდე.

თქვენი ორგანიზაციის ID მითითებულია თქვენი სამართავი პანელის API გასაღებების ეკრანზე, თავად გასაღებთან ახლოს. ის ერთნაირია თქვენ მიერ განხორციელებულ ყველა გამოძახებაში.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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> }'

შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი API კონსოლში

დეტალები

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_id`	`string`	დიახ	—
`period_start`	`string`	დიახ	Any instant in the calendar month being claimed; the month is derived from it.
`credit_percent`	`integer`	არა	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…

პასუხი

სახელი	ტიპი	სავალდებულო	რა არის ეს
`id`	`string`	დიახ	—
`period_start`	`string`	დიახ	—
`credit_percent`	`integer`	დიახ	—
`amount_minor`	`integer`	დიახ	The credit in integer minor units of `currency` (§2.8 — money is never a float).
`currency`	`string`	დიახ	—
`outcome`	`string<measured, unadjudicable>`	დიახ	Whether the month adjudicated, or the credit was granted because our coverage could not decide it.
`uptime_percent`	`string`	დიახ	—
`created_at`	`string`	დიახ	—

შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს

401 · 403 · 404 · 409 · 422

POST /v1/sla/claims