connections

GET /v1/registrar-domains

The domains in the organization's linked registrar accounts.

Всички крайни точки в connections

Всички документи за разработчици

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението sites.view; ключ без него се отхвърля с 403, а не с 404.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

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.

Параметри

ИмеТипЗадължителноКакво представлява
provider (query)ConnectionProviderНеShow only one linked provider's domains, e.g. registrar_godaddy.
state (query)RegistrarDomainStateНеShow only domains in one state.

Отговор

ИмеТипЗадължителноКакво представлява
itemsRegistrarDomain[]Да
totalintegerДаHow many domains match before the page limit. ⛔ Compare it with items.length before telling a customer this is all of them.
accountsRegistrarAccount[]Да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.

Грешки, които този крайpoint може да върне

401 · 403 · 422 · 429