connector-catalog-public@1.0.0
公開コネクタカタログ
Apus が公開しているコネクタの種類と、それぞれの準備状況を確認できます。認証は不要です。
凍結済みの契約バージョン 1.0.0 から生成。凍結済みのバージョンが変更されることはありません。
操作
get/v1/public/connectors
ページ分割なしでカタログ全体を一度に返します。保持している ETag を If-None-Match で送ると、変更がない場合は 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 による受信、署名付き Webhook による送信、または定期取得。 |
| status | live | beta | roadmap | はい | 準備状況：live、beta、roadmap のいずれか。 |
| summary | string | いいえ | 任意の短い説明。 |
| docs_url | string (uri) | いいえ | この種類の公開ドキュメントページ（任意）。 |