Download OpenAPI specification:
API для интеграций с внешними системами.
Позволяет получать события, произошедшие в системе (/events)
и подтверждать их успешную обработку (/events/acks).
Основные особенности:
POST /events/acks
с передачей списка UUID событий.Authorization: Token token=<API_KEY>.200 OK - Запрос успешно выполнен, и сервер вернул запрашиваемые данные.204 No Content - Запрос успешно выполнен, но сервер не возвращает никаких данных.401 Unauthorized - Запрос требует аутентификации. API ключ недействителен или отсутствует. Заголовок Authorization отсутствует или недействителен.422 Unprocessable Entity - Запрос содержит некорректные данные или не может быть обработан по бизнес-правилам.Возвращает список событий, которые ожидают обработки.
| public_id required | string Examples: outgoing-integration-123 Внешний (публичный) идентификатор интеграции. |
{- "events": [
- {
- "uuid": "9d82fff9-d029-44b2-b6b7-133b957aa926",
- "created_at": "2025-08-29T10:15:30.123Z",
- "event_type": "integration_payload_processed",
- "data": {
- "reference_number": "REF-000123",
- "status": "ok",
- "message": "Payload accepted",
- "created_at": "2025-08-29T10:15:30.123Z",
- "processed_at": "2025-08-29T10:16:00.000Z",
}
}
]
}Отмечает события как успешно обработанные.
| public_id required | string Examples: outgoing-integration-123 Внешний (публичный) идентификатор интеграции. |
| item_uuids required | Array of strings <uuid> (Uuid) non-empty [ items <uuid >^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-... ] Список UUID событий для подтверждения (ack). |
{- "item_uuids": [
- "9d82fff9-d029-44b2-b6b7-133b957aa926",
- "1d82ff32-d021-45b2-b6b7-183b953aa927"
]
}{- "code": "contract_validation_error",
- "message": "Найдены ошибки при проверке данных для выполнения операции",
- "errors": { },
- "meta": { }
}