PATCH/v1/apps/{app_id}

Ажурирање OAuth апликације

update_app

Мења поља која проследите. Сужавање scopes одмах сужава већ издате токене; проширење се примењује само на нове ауторизације. role и data_profile примењују се само на апликацију confidential. Тип клијента не може да се промени. Додато у верзији 1.62.0.

Аутентификација

Пошаљите API кључ у заглављу Authorization: Authorization: Bearer <кључ>.

Параметри путање

app_idstringобавезно
ID апликације (app_…), који је уједно и client_id.
length ≤ 36

Параметри заглавља

Idempotency-Keystring
Кључ за безбедан поновни покушај уписа: од 1 до 255 штампаних ASCII знакова; препоручује се UUID v4 за сваку логичку операцију. Поновни покушај са истим кључем у року од 24 сата не извршава операцију поново: враћа сачувани одговор (статус, заглавља и тело) са заглављем Idempotency-Replayed: true. Исти кључ са другим методом, путањом, Content-Type или телом враћа 409 api.idempotency_mismatch; док се први захтев још извршава – 409 api.idempotency_in_progress са Retry-After: 1. После одговора 5xx или 429 кључ се ослобађа и поновни покушај поново извршава операцију. Кључ важи у оквиру организације и позиваоца (API кључ, корисник или кључ сопственог извора).
length ≥ 1, length ≤ 255

Тело захтева

application/json

Објекат: OAuthAppUpdate

namestring
Назив за екран за давање пристанка.
length ≥ 1, length ≤ 100
descriptionstring
Опис за екран за давање пристанка.
length ≤ 1000
homepage_urlstring | null
Веб-сајт апликације; null или празан стринг га уклања.
length ≤ 2000
redirect_urisarray of string
Потпуна нова листа адреса (URI) за преусмеравање.
items ≤ 10
scopesarray of OAuthScope
Потпуни нови скуп опсега.
items ≥ 1
rolestring
Улога токена client credentials (само confidential).
data_profilestring
Профил приступа токена client credentials (само confidential).

Одговори

200Успешан одговор

Заглавља одговора

RateLimit-Policy
Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.
RateLimit
Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).
X-RateLimit-Remaining
Број преосталих захтева по најстрожем ограничењу.
X-RateLimit-Reset
Број секунди до ресетовања најстрожег ограничења.
Idempotency-Replayed
true значи да је одговор поново послат из одговора сачуваног за овај Idempotency-Key: операција није поново извршена.

application/json

Објекат: OAuthApp

idstringобавезно
ID апликације (app_ и 32 хексадецимална знака), који је уједно и client_id.
namestringобавезно
Назив који запослени види на екрану за давање пристанка.
descriptionstringобавезно
Опис за екран за давање пристанка (може бити празан).
homepage_urlstring | nullобавезно
Веб-сајт апликације.
client_typeOAuthClientTypeобавезно
redirect_urisarray of stringобавезно
Дозвољене адресе (URI) за преусмеравање (тачно подударање стринга).
scopesarray of OAuthScopeобавезно
Опсези које апликација може да затражи.
client_secret_prefixstring | nullобавезно
Први знакови тајне клијента, ради препознавања; null за јавну апликацију.
rolestring | nullобавезно
Улога токена client credentials (admin, editor, verifier, viewer); null за јавну апликацију.
data_profilestring | nullобавезно
Профил приступа токена client credentials; null за јавну апликацију.
authorizationsintegerобавезно
Број активних ауторизација запослених.
created_atstring (date-time)обавезно
updated_atstring (date-time)обавезно

400Захтев није исправан: вредност параметра или стање објекта не дозвољава радњу (`detail` је порука).

Заглавља одговора

RateLimit-Policy
Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.
RateLimit
Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).
X-RateLimit-Remaining
Број преосталих захтева по најстрожем ограничењу.
X-RateLimit-Reset
Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

401Акредитиви нису послати (ни колачић сесије ни API кључ) или кључ није пронађен.

Заглавља одговора

RateLimit-Policy
Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.
RateLimit
Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).
X-RateLimit-Remaining
Број преосталих захтева по најстрожем ограничењу.
X-RateLimit-Reset
Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

403Радња није дозвољена: улога није довољна, нема приступа колекцији или картици, захтев се извршава у режиму „View as“ или је организација суспендована или обрисана (`detail` је објекат са `code: org_suspended | org_deleted`).

Заглавља одговора

RateLimit-Policy
Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.
RateLimit
Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).
X-RateLimit-Remaining
Број преосталих захтева по најстрожем ограничењу.
X-RateLimit-Reset
Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

404Објекат не постоји или вам није доступан. API не потврђује да објекат са ограниченим приступом постоји.

Заглавља одговора

RateLimit-Policy
Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.
RateLimit
Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).
X-RateLimit-Remaining
Број преосталих захтева по најстрожем ограничењу.
X-RateLimit-Reset
Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

409Стање објекта не дозвољава радњу, на пример дупликат, индексирање у току или посао који је већ обрађен.

Заглавља одговора

RateLimit-Policy
Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.
RateLimit
Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).
X-RateLimit-Remaining
Број преосталих захтева по најстрожем ограничењу.
X-RateLimit-Reset
Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

422Грешка валидације: тело или параметри не одговарају шеми (`detail` је листа грешака валидације) или је вредност параметра ван дозвољеног распона (`detail` је порука).

Заглавља одговора

RateLimit-Policy
Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.
RateLimit
Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).
X-RateLimit-Remaining
Број преосталих захтева по најстрожем ограничењу.
X-RateLimit-Reset
Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

429Превише захтева (`api.rate_limited`), квота организације за минут, дан или месец је потрошена (`api.quota_exceeded`; `error.details` садржи `quota`, `limit` и `reset_at`), достигнуто је ограничење организације или је сервис за одговоре заузет (`answers.engine_busy`). Сачекајте време наведено у заглављу `Retry-After`.

Заглавља одговора

Retry-After
Број секунди које треба сачекати пре поновног покушаја захтева.
RateLimit-Policy
Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.
RateLimit
Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).
X-RateLimit-Remaining
Број преосталих захтева по најстрожем ограничењу.
X-RateLimit-Reset
Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

Кодови грешака

Кодови које ова операција може да врати у error.code, поред општих кодова сваког захтева.

Безбедни поновни покушаји

Уз сваки POST и PATCH захтев пошаљите заглавље Idempotency-Key (на пример UUID). Поновни покушај са истим кључем у року од 24 сата враћа сачувани одговор уместо да поново изврши захтев.

Ограничења учесталости

Одговори садрже заглавља RateLimit и RateLimit-Policy, као и старија X-RateLimit-Limit, X-RateLimit-Remaining и X-RateLimit-Reset. Одговор 429 садржи заглавље Retry-After у секундама: сачекајте и поновите захтев.

← apps · API референца

curl -X PATCH 'https://api.sursa.com/v1/apps/APP_ID' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"support","description":"Customer support articles","homepage_url":"string"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Испробајте

API кључ

Кључ остаје у меморији овог језичка прегледача и шаље се само на https://api.sursa.com.

Захтеви раде са стварним подацима ваше организације.

app_id path *

Idempotency-Key header

Idempotency-Key

Ако је поље празно, за сваки захтев се генерише нови кључ.

Тело захтева (JSON)