connections

GET /v1/connections/providers

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

Semua titik akhir connections

Pengesahan

Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.

Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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.

Respons

NamaJenisDiperlukanApakah ia
dataConnectionProviderDescriptor[]Ya

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 429