connector-catalog-public@1.0.0
Öffentlicher Konnektor-Katalog
Lesen Sie den Katalog der von Apus veröffentlichten Konnektortypen und ihren Reifegrad. Keine Authentifizierung erforderlich.
Erstellt aus dem eingefrorenen Vertrag, Version 1.0.0. Eingefrorene Versionen werden nie geändert.
Operationen
get/v1/public/connectors
Liefert den gesamten Katalog in einer Antwort, ohne Paginierung. Senden Sie If-None-Match mit dem gespeicherten ETag, um 304 zu erhalten, wenn sich nichts geändert hat.
Keine Authentifizierung erforderlich · getPublicConnectorCatalog
Parameter
| Name | Ort | Typ | Pflicht |
|---|---|---|---|
| If-None-Match | header | string | Nein |
Antworten
200— Der aktuelle Katalog. Ein leeres Array ist gültig: Es wurde noch nichts veröffentlicht.304— Der Katalog hat sich seit dem gesendeten ETag nicht geändert.500— Der Katalog konnte nicht erstellt werden. Als fehlende Daten behandeln, nie als leeren Katalog.
Datenmodelle
ConnectorCatalog
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| contract | "connector-catalog-public/1.0.0" | Ja | Ausgelieferte Vertragsversion. |
| generated_at | string (date-time) | Ja | Erstellungszeitpunkt des Katalogs (UTC, RFC 3339). |
| connectors | PublicConnector[] | Ja | Alle veröffentlichten Typen; kann leer sein. |
PublicConnector
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| key | string | Ja | Dauerhafte Kennung des Konnektortyps; als Link-Anker geeignet. |
| name | string | Ja | Anzeigename; nicht zum Abgleich verwenden. |
| direction | inbound_api | webhook_out | polling_adapter | Ja | Datenrichtung: eingehend per API, ausgehend per signiertem Webhook oder periodischer Abruf. |
| status | live | beta | roadmap | Ja | Reifegrad: live, beta oder roadmap. |
| summary | string | Nein | Optionale Kurzbeschreibung. |
| docs_url | string (uri) | Nein | Optionale öffentliche Dokumentationsseite für diesen Typ. |