compute
POST /v1/compute/eligibility
Submit an organisation for verification.
تصدیقهویت
یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د billing.payment.manage اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.
چیرته چې ستاسو د سازمان آی ډي ځي
دا پای ټکی د پوښتنې پیرامیتر په توګه org_id اخلي. دا پریږدئ او زنګ ستاسو د استوګنې ټولې څانګې پوښي؛ د یوې سازمان لپاره د زنګ محدودولو لپاره یې واستوئ.
ستاسو د سازمان آی ډي ستاسو په ډشبورډ کې د API کېلي پر سکرین، خپله د کېلي څنګ ته شتون لري. دا په هره هغه غوښتنه کې چې تاسو یې کوئ، ورته آی ډي وي.
هڅه وکړئ
د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.
curl -X POST https://api.zinndigital.com/v1/compute/eligibility \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "legal_name": <string>, "country": <string>, "abuse_contact_email": <string> }'ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ
تفصیلات
Moves the organisation to pending for a human to review. 202, because the answer is a decision somebody makes rather than something this call performs. ⛔ An organisation that is already verified, or already pending, is refused 422 rather than silently re-queued: resubmitting would otherwise let a customer suspend their own verification, and let a rejected applicant re-enter the queue for ever. Requires billing.payment.manage — ⛔ not billing.entitlement.manage, a staff key no customer role holds, which is what this said until D10689.
پارامترونه
| نوم | ډول | اړین | دا څه شی دی |
|---|---|---|---|
org_id (query) | Uuid | نه | — |
د غوښتنې بدن
| نوم | ډول | اړین | دا څه شی دی |
|---|---|---|---|
legal_name | string | هو | — |
country | string | هو | — |
abuse_contact_email | string | هو | — |
company_number | string | نه | — |
intended_use | string | نه | — |
ځواب
| نوم | ډول | اړین | دا څه شی دی |
|---|---|---|---|
state | string<not_requested, pending, verified, rejected> | هو | ⛔ Four states, not a boolean. not_requested and rejected both refuse an order and the customer's next action differs completely: one is "tell us who you are", the other is "we… |
may_order | boolean | هو | True only in verified. Read this rather than re-deriving it from state. |
legal_name | string | هو | The legal name of whoever is responsible for the machines. |
country | string | هو | ISO-3166-1 alpha-2 country of the person or the incorporation. |
company_number | string | هو | Company registration number, or "" for an individual — a real answer. |
abuse_contact_email | string | هو | A monitored address an abuse report can be forwarded to and answered from. We are the account holder of record, so a complaint reaches us first and has to reach the customer… |
intended_use | string | هو | What the customer says the machines are for, in their own words. |
rejection_reason | string | هو | Shown to the customer verbatim when state is rejected. |
submitted_at | string | هو | — |
reviewed_at | string | هو | — |
تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي
401 · 403 · 422 · 429