connections

GET /v1/connections/providers

Every provider a customer can connect, with its form and its checklist.

Tous les points de terminaison connections

Toute la documentation pour développeurs

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

curl -X GET https://api.zinndigital.com/v1/connections/providers \
  -H "Authorization: Bearer zdk_live_…"

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

The catalogue: for each connectable provider, which credential fields it takes (and which of them are secret), and which permissions we will test it for. Served as an endpoint rather than baked into each client because the six BYO DNS vendors take credentials of one, two and five fields — ClouDNS needs auth_id and auth_password, Azure needs five — and hardcoding those in a client duplicates the driver's own required_settings across the wire, where the two copies are free to drift apart. Every field name here is read off the driver class itself, so a vendor that gains a required setting changes this response and cannot be connected with a bundle it will refuse. shapes is a list of alternative credential forms; a client renders the first and offers the rest. Cloudflare is the live case: a scoped API token, or the account email plus its Global API Key. permissions is empty when we have no permission model for that provider. ⛔ Render that as "we cannot test this provider's permissions" — never as a satisfied (empty) checklist, which is a different and wrong claim. Requires authentication only; it describes what can be connected, not what anyone has connected.

Réponse

NomTypeObligatoireQu'est-ce que c'est
dataConnectionProviderDescriptor[]Oui

Erreurs que cet point de terminaison peut renvoyer

401 · 429