ਪ੍ਰਮਾਣੀਕਰਨ
ਇੱਕ API ਕੁੰਜੀ ਨੂੰ ਬੀਅਰ ਟੋਕਨ ਵਜੋਂ ਭੇਜੋ। ਇਹ ਐਂਡਪੁਆਇੰਟ ਸਪੈਸੀਫਿਕੇਸ਼ਨ ਵਿੱਚ ਕਿਸੇ ਖਾਸ ਇਜਾਜ਼ਤ ਨੂੰ ਨਹੀਂ ਦਰਸਾਉਂਦਾ, ਇਸ ਲਈ ਆਪਣੀ ਕੁੰਜੀ ਨੂੰ ਘੱਟੋ-ਘੱਟ ਲੋੜੀਂਦੀਆਂ ਇਜਾਜ਼ਤਾਂ ਦਿਓ ਅਤੇ ਮੰਨਣ ਦੀ ਬਜਾਏ ਜਵਾਬ ਦੀ ਜਾਂਚ ਕਰੋ।
ਜਿੱਥੇ ਤੁਹਾਡੀ ਸੰਸਥਾ ਦੀ ਆਈਡੀ ਆਉਂਦੀ ਹੈ
ਇਹ ਐਂਡਪੁਆਇੰਟ org_id ਨੂੰ ਇੱਕ ਕੌਂਸਲ ਪੈਰਾਮੀਟਰ ਵਜੋਂ ਲੈਂਦਾ ਹੈ। ਇਸਨੂੰ ਛੱਡ ਦਿਓ ਅਤੇ ਕਾਲ ਤੁਹਾਡੇ ਪੂਰੇ ਟੈਨੈਂਸੀ ਸਬਟ੍ਰੀ ਨੂੰ ਕਵਰ ਕਰੇਗੀ; ਕਾਲ ਨੂੰ ਇੱਕ ਸੰਸਥਾ ਤੱਕ ਸੀਮਤ ਕਰਨ ਲਈ ਇਸਨੂੰ ਭੇਜੋ।
ਤੁਹਾਡੀ ਸੰਸਥਾ ਦੀ ਆਈਡੀ ਤੁਹਾਡੇ ਡੈਸ਼ਬੋਰਡ 'ਤੇ API ਕੁੰਜੀਆਂ ਵਾਲੀ ਸਕ੍ਰੀਨ 'ਤੇ, ਕੁੰਜੀ ਦੇ ਬਿਲਕੁਲ ਨਾਲ ਮੌਜੂਦ ਹੈ। ਇਹ ਤੁਹਾਡੇ ਵੱਲੋਂ ਕੀਤੀ ਜਾਣ ਵਾਲੀ ਹਰ ਕਾਲ ਵਿੱਚ ਉਹੀ ਆਈਡੀ ਹੁੰਦੀ ਹੈ।
ਕੋਸ਼ਿਸ਼ ਕਰੋ
ਕੋਈ ਵੀ ਚੀਜ਼ ਜੋ ਕੋਣ ਵਾਲੇ ਬਰੈਕਟਾਂ ਵਿੱਚ ਹੈ ਉਸਨੂੰ ਆਪਣੇ ਖੁਦ ਦੇ ਮੁੱਲਾਂ ਨਾਲ ਬਦਲੋ, ਅਤੇ ਕੁੰਜੀ ਪਲੇਸਹੋਲਡਰ ਨੂੰ ਆਪਣੇ ਡੈਸ਼ਬੋਰਡ ਦੀ ਇੱਕ ਕੁੰਜੀ ਨਾਲ ਬਦਲੋ।
curl -X GET https://api.zinndigital.com/v1/notices \
-H "Authorization: Bearer zdk_live_…"ਲੌਗ ਇਨ ਕੀਤਾ ਹੋਇਆ ਹੈ? ਤੁਹਾਡੇ ਡੈਸ਼ਬੋਰਡ ਵਿੱਚ API ਕੰਸੋਲ ਤੁਹਾਡੀ ਅਸਲ ਸੰਸਥਾ ਆਈਡੀ (organisation id) ਅਤੇ ਤੁਹਾਡੀ ਆਪਣੀ ਕੁੰਜੀ ਨੂੰ ਭਰਦਾ ਹੈ, ਅਤੇ ਲਾਈਵ API ਦੇ ਵਿਰੁੱਧ ਬੇਨਤੀ ਚਲਾਉਂਦਾ ਹੈ ਤਾਂ ਜੋ ਤੁਸੀਂ ਅਸਲ ਜਵਾਬ ਦੇਖ ਸਕੋ। API ਕੰਸੋਲ ਵਿੱਚ ਇਸ ਐਂਡਪੁਆਇੰਟ ਨੂੰ ਖੋਲ੍ਹੋ
ਵੇਰਵੇ
docs/87. What the platform is currently telling **this** customer, on **this** route, in **their** language — already sanitised, already localised. ⛔ No permission key. Reading the notices aimed at you is not a privilege: gating it would mean a member whose role happens to lack `org.read` never learns their card needs re-adding. The audience is the scope — a notice reaches an organization only if it is explicitly `everyone` or that org is named in its audience. An untargeted notice reaches nobody, never everybody. Exactly one of `body_html` and `body_i18n_key` is populated (a database constraint). `body_html` is operator-authored and safe to render as HTML; `body_i18n_key` + `body_params` are rendered from the SPA's own catalogue.
ਪੈਰਾਮੀਟਰ
| ਨਾਮ | ਕਿਸਮ | ਲਾਜ਼ਮੀ | ਕੀ ਹੈ ਇਹ |
|---|---|---|---|
route (query) | string | ਨਹੀਂ | The dashboard path being rendered, e.g. `/billing/invoices`. Defaults to `/`. A query string is ignored, so a notice aimed at `/billing` does not vanish when the screen adds a tab. |
org_id (query) | string | ਨਹੀਂ | Narrow to one organization. Omitted, the caller's whole accessible subtree is considered, so a reseller admin sees a notice aimed at a client org they manage. An id outside that… |
ਜਵਾਬ
| ਨਾਮ | ਕਿਸਮ | ਲਾਜ਼ਮੀ | ਕੀ ਹੈ ਇਹ |
|---|---|---|---|
data | Notice[] | ਹਾਂ | — |
ਇਹ ਐਂਡਪੁਆਇੰਟ ਜੋ ਗਲਤੀਆਂ ਵਾਪਸ ਕਰ ਸਕਦਾ ਹੈ
401 · 429