Bỏ qua, tới nội dung chính

connector-catalog-public@1.0.0

Danh mục connector công khai

Đọc danh mục các loại connector Apus đã công bố và mức sẵn sàng của từng loại. Không cần xác thực.

Dựng từ hợp đồng đã đóng băng, phiên bản 1.0.0. Phiên bản đã đóng băng không bao giờ bị sửa.

Thao tác

get/v1/public/connectors

Trả toàn bộ danh mục trong một phản hồi, không phân trang. Gửi If-None-Match với ETag đã giữ để nhận 304 khi danh mục chưa đổi.

Không cần xác thực · getPublicConnectorCatalog

Tham số

TênVị tríKiểuBắt buộc
If-None-MatchheaderstringKhông

Phản hồi

  • 200 — Danh mục hiện tại. Mảng rỗng là hợp lệ: chưa công bố loại nào.
  • 304 — Danh mục chưa đổi kể từ ETag đã gửi.
  • 500 — Không dựng được danh mục. Xử lý như chưa có dữ liệu, đừng hiển thị danh mục rỗng.

Mô hình dữ liệu

ConnectorCatalog

TrườngKiểuBắt buộcMô tả
contract"connector-catalog-public/1.0.0"CóPhiên bản hợp đồng đang phục vụ.
generated_atstring (date-time)CóThời điểm danh mục được dựng (UTC, RFC 3339).
connectorsPublicConnector[]CóToàn bộ các loại đã công bố; có thể rỗng.

PublicConnector

TrườngKiểuBắt buộcMô tả
keystringCóĐịnh danh vĩnh viễn của loại connector; an toàn để dùng làm neo liên kết.
namestringCóTên hiển thị; không dùng để so khớp.
directioninbound_api | webhook_out | polling_adapterCóHướng dữ liệu: vào qua API, ra qua webhook có ký, hoặc kéo định kỳ.
statuslive | beta | roadmapCóMức sẵn sàng: live, beta hoặc roadmap.
summarystringKhôngMô tả ngắn, tuỳ chọn.
docs_urlstring (uri)KhôngTrang tài liệu công khai của loại này, tuỳ chọn.