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

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

getStorefront

Обновлено

GET /api/v1/tools/storefront

Read tenant storefront settings

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

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["storefront:read"]

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

ПолеЗначение
Параметры[]

Тело запроса

ПолеЗначение
Тело запросаnull

Ответы

ПолеЗначение
200.content.application/json.schemaStorefrontView
200.description"Tenant display settings, with no internal Client identifier"
200.headers.X-Bot-Username.description"Authenticated public bot username, when available"
200.headers.X-Bot-Username.schema200.headers.X-Bot-Username.schema
200.headers.X-Client-Slug.description"Authenticated active tenant slug, when available"
200.headers.X-Client-Slug.schema200.headers.X-Client-Slug.schema
200.headers.X-RateLimit-Limit.description"Effective request budget"
200.headers.X-RateLimit-Limit.schema200.headers.X-RateLimit-Limit.schema
200.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
200.headers.X-RateLimit-Remaining.schema200.headers.X-RateLimit-Remaining.schema
200.headers.X-RateLimit-Reset.description"Window reset Unix seconds"
200.headers.X-RateLimit-Reset.schema200.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
401.content.application/problem+json.schemaProblemDetails
401.description"INVALID_API_KEY: missing, invalid, revoked or conflicting credential headers; surface-session JWT is refused"
403.content.application/problem+json.schemaProblemDetails
403.description"INSUFFICIENT_SCOPE or NO_ACTIVE_BOT; publishable keys are refused on settings"
404.content.application/problem+json.schemaProblemDetails
404.description"NOT_FOUND: storefront settings unavailable; detail contains no internal tenant identifier"
413.content.application/problem+json.schemaProblemDetails
413.description"PAYLOAD_TOO_LARGE or ITEM_COUNT_EXCEEDED: per-tool resource limits"
429.content.application/problem+json.schemaProblemDetails
429.description"RATE_LIMIT_EXCEEDED or RATE_LIMIT_UNAVAILABLE: resource budget refusal"
429.headers.Retry-After.description"Retry delay in seconds, when supplied by the limiter"
429.headers.Retry-After.schema429.headers.Retry-After.schema
500.content.application/problem+json.schemaProblemDetails
500.description"INTERNAL_ERROR: unexpected failure; no internal payload is exposed"

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

ПолеЗначение
description"P3 singleton selected only by authenticated tenant metadata. Settings-authorized storefront:read scope. X-Api-Key OR Bearer tgf_* credentials; surface-session JWT is not accepted. No pagination or conditional ETag contract."
operationId"getStorefront"
summary"Read tenant storefront settings"
tags["storefront"]
x-idempotency.mode"none"
x-pagination.queryParameters[]
x-pagination.supportedfalse