Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) billing.payment.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
A szervezet azonosítójának helye
Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
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> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
org_id (query) | Uuid | Nem | — |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
legal_name | string | Igen | — |
country | string | Igen | — |
abuse_contact_email | string | Igen | — |
company_number | string | Nem | — |
intended_use | string | Nem | — |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
state | string<not_requested, pending, verified, rejected> | Igen | ⛔ 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 "… |
may_order | boolean | Igen | True only in `verified`. Read this rather than re-deriving it from `state`. |
legal_name | string | Igen | The legal name of whoever is responsible for the machines. |
country | string | Igen | ISO-3166-1 alpha-2 country of the person or the incorporation. |
company_number | string | Igen | Company registration number, or `""` for an individual — a real answer. |
abuse_contact_email | string | Igen | 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 wit… |
intended_use | string | Igen | What the customer says the machines are for, in their own words. |
rejection_reason | string | Igen | Shown to the customer **verbatim** when `state` is `rejected`. |
submitted_at | string | Igen | — |
reviewed_at | string | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 422 · 429