connections
GET /v1/registrar-domains
The domains in the organization's linked registrar accounts.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation sites.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
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/registrar-domains \
-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
Everything we can see in the GoDaddy, Namecheap or Porkbun accounts the customer has connected, with what we last observed about each name and what — if anything — they need to do about it. ⛔ These are not Domain resources and the two must not be conflated. A Domain is a name the platform is responsible for: we sell it, we renew it, a workflow drives every transition. A row here is a name registered somewhere we did not sell it, whose renewal and ownership are entirely the customer's — we may read it and we may point it at a site, and that is the whole surface. matched_domain_id is the one place they meet, set when a Domain for the same name exists in the same organization. ⛔ nameservers is null when we have never read the delegation — never [], which would say the domain is delegated nowhere. Two of the three registrars' account listings do not carry nameservers at all, so null is the ordinary state of a freshly imported row. ⛔ state is our verdict (is there anything to tell you?) and registrar_status is the vendor's own word, carried through verbatim and unmapped. They answer different questions and a client must not render one as the other: three registrars use three vocabularies, and deciding what AWAITING_VERIFICATION "really" means is not a decision this API takes on a screen whose job is to show the customer what their registrar says. accounts is served beside the domains because a connected account holding zero domains is a state the screen must render — a Porkbun key scoped to no domain, or an account genuinely empty — and a domain list alone cannot express it. ⛔ total is the count before the page limit and is not decoration: a list that silently stops is the same shape as a complete one, and the customer's conclusion from it ("these are all my domains") is exactly the wrong one. Requires sites.view — seeing which domains you hold is not managing a credential.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
provider (query) | ConnectionProvider | Non | Show only one linked provider's domains, e.g. registrar_godaddy. |
state (query) | RegistrarDomainState | Non | Show only domains in one state. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
items | RegistrarDomain[] | Oui | — |
total | integer | Oui | How many domains match before the page limit. ⛔ Compare it with items.length before telling a customer this is all of them. |
accounts | RegistrarAccount[] | Oui | The linked accounts these domains came from — served here because an account with zero domains is a state the screen must render and a domain list cannot express. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 422 · 429