connections

GET /v1/connections/providers

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

Všechny koncové body connections

Všechny dokumenty pro vývojáře

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Odpověď

NázevTypPožadovánoCo to je
dataConnectionProviderDescriptor[]Ano

Chyby, které může tento koncový bod vrátit

401 · 429