К содержанию
TelegaFirst

Для AI-агентов: markdown этой страницы — /docs/api-op-registerminiapporigin.mdиндекс документации — /llms.txt

registerMiniAppOrigin

Обновлено

POST /api/v1/tools/onboarding/mini-app-origin

registerMiniAppOrigin

Авторизация и права

Scopes: ALL. Auth alternatives: OR; scopes внутри альтернативы: ALL.

ПолеЗначение
security.0.hubApiKey[]
security.1.hubBearer[]
securitySchemes.hubApiKey.in"header"
securitySchemes.hubApiKey.name"X-Api-Key"
securitySchemes.hubApiKey.type"apiKey"
securitySchemes.hubBearer.scheme"bearer"
securitySchemes.hubBearer.type"http"
x-required-scopes["onboarding:write"]

Параметры запроса

ПолеЗначение
0.description"Required for the nonempty canonical Mini App registration request."
0.in"header"
0.name"Idempotency-Key"
0.requiredtrue
0.schema0.schema

Тело запроса

ПолеЗначение
content.application/json.schemacontent.application/json.schema
requiredtrue

Ответы

ПолеЗначение
201.content.application/json.schemaMiniAppOriginRegistration
201.description"The tenant host is recorded as the channel's Mini App origin in status pending, with the recipe the owner follows: the BotFather Mini App URL for Telegram, the business.max.ru Mini App URL for MAX (moderated), nothing to paste for VK. The origin becomes registered on the first validly signed launch from it. No messenger API is called (ADR-331 D4)."

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Request body failed validation — a non-HTTPS origin, an origin other than the zone's tenant host, an unknown zone, or a smuggled tenant id."
401.content.application/problem+json.schemaProblemDetails
401.description"Missing, invalid, revoked, or expired Hub credential."
403.content.application/problem+json.schemaProblemDetails
403.description"The authenticated credential lacks the onboarding:write scope."
422.content.application/problem+json.schemaProblemDetails
422.description"INVALID_INPUT: the channel has no Mini App in this zone (MAX and VK accept only ru)."

Дополнительные условия

ПолеЗначение
operationId"registerMiniAppOrigin"
tags["onboarding"]
x-idempotency"http-cache"