compute
POST /v1/compute/eligibility
Submit an organisation for verification.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה billing.payment.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את 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 בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-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 "… |
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 wit… |
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