connections

GET /v1/registrar-domains

The domains in the organization's linked registrar accounts.

所有 connections 端点

所有开发者文档

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

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

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 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)ConnectionProviderShow only one linked provider's domains, e.g. registrar_godaddy.
state (query)RegistrarDomainStateShow only domains in one state.

响应

名称类型必填内容简介
itemsRegistrarDomain[]
totalintegerHow 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.

此端点可能返回的错误

401 · 403 · 422 · 429