connector-catalog-public@1.0.0
Публичный каталог коннекторов
Каталог типов коннекторов, опубликованных Apus, и степень готовности каждого. Аутентификация не требуется.
Построено по замороженному контракту, версия 1.0.0. Замороженные версии никогда не меняются.
Операции
get/v1/public/connectors
Возвращает весь каталог одним ответом, без пагинации. Отправьте If-None-Match с сохранённым ETag, чтобы получить 304, если ничего не изменилось.
Аутентификация не требуется · getPublicConnectorCatalog
Параметры
| Имя | Где | Тип | Обязательно |
|---|---|---|---|
| If-None-Match | header | string | Нет |
Ответы
200— Текущий каталог. Пустой массив допустим: пока ничего не опубликовано.304— Каталог не изменился с момента отправленного ETag.500— Не удалось сформировать каталог. Считайте это отсутствием данных, а не пустым каталогом.
Модели данных
ConnectorCatalog
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
| contract | "connector-catalog-public/1.0.0" | Да | Обслуживаемая версия контракта. |
| generated_at | string (date-time) | Да | Время формирования каталога (UTC, RFC 3339). |
| connectors | PublicConnector[] | Да | Все опубликованные типы; может быть пустым. |
PublicConnector
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
| key | string | Да | Постоянный идентификатор типа коннектора; подходит как якорь ссылки. |
| name | string | Да | Отображаемое имя; не используйте для сопоставления. |
| direction | inbound_api | webhook_out | polling_adapter | Да | Направление данных: входящие через API, исходящие через подписанные вебхуки или периодический сбор. |
| status | live | beta | roadmap | Да | Готовность: live, beta или roadmap. |
| summary | string | Нет | Необязательное краткое описание. |
| docs_url | string (uri) | Нет | Необязательная публичная страница документации этого типа. |