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

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

configureIntegration

Обновлено

POST /api/v1/tools/integrations

Configure tenant CRM connector

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

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["integrations:write"]

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

ПолеЗначение
0.in"header"
0.name"Idempotency-Key"
0.requiredtrue
0.schema0.schema

Тело запроса

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

Ответы

ПолеЗначение
201.content.application/json.schemaIntegrationView
201.description"Configured non-secret connector"
201.headers.X-Bot-Username.description"Authenticated active public bot username when available"
201.headers.X-Bot-Username.schema201.headers.X-Bot-Username.schema
201.headers.X-Client-Slug.description"Authenticated active tenant slug when available"
201.headers.X-Client-Slug.schema201.headers.X-Client-Slug.schema
201.headers.X-RateLimit-Limit.description"Effective per-minute limit"
201.headers.X-RateLimit-Limit.schema201.headers.X-RateLimit-Limit.schema
201.headers.X-RateLimit-Remaining.description"Remaining requests, or unknown"
201.headers.X-RateLimit-Remaining.schema201.headers.X-RateLimit-Remaining.schema
201.headers.X-RateLimit-Reset.description"Window reset epoch seconds"
201.headers.X-RateLimit-Reset.schema201.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"VALIDATION_ERROR: invalid strict request; IDEMPOTENCY_KEY_REQUIRED: POST body without key"
401.content.application/problem+json.schemaProblemDetails
401.description"INVALID_API_KEY: missing, conflicting, invalid, expired or revoked credential; surface JWT unsupported"
403.content.application/problem+json.schemaProblemDetails
403.description"INSUFFICIENT_SCOPE, PUBLISHABLE_KEY_NOT_ALLOWED or NO_ACTIVE_BOT"
409.content.application/problem+json.schemaProblemDetails
409.description"CONFLICT: idempotent request is processing"
413.content.application/problem+json.schemaProblemDetails
413.description"PAYLOAD_TOO_LARGE or ITEM_COUNT_EXCEEDED"
422.content.application/problem+json.schemaProblemDetails
422.description"IDEMPOTENCY_KEY_MISMATCH: same key with different request inputs"
429.content.application/problem+json.schemaProblemDetails
429.description"RATE_LIMIT_EXCEEDED or RATE_LIMIT_UNAVAILABLE: fail-closed resource limit"
429.headers.Retry-After.description"Retry delay in seconds when supplied by resource policy"
429.headers.Retry-After.schema429.headers.Retry-After.schema

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

ПолеЗначение
description"Owner-authorized strict upsert by credentials.type (bitrix24/getcourse). Credentials are encrypted with tenant AAD and never returned. Reconfiguring reactivates a deleted connector. Idempotency-Key required for POST body; actor/tenant/handler replay lasts 86400 seconds and preserves 201. Changed inputs return 422; processing returns 409. Bearer accepts tgf_* credentials, not surface JWT."
operationId"configureIntegration"
summary"Configure tenant CRM connector"
tags["integrations"]