域名 API - API 命令列表

Dynadot API

开始使用我们的 RESTful API

Dynadot API 旨在与您的系统无缝集成。我们的 API 具有可预测的面向资源的 URL，支持 JSON 编码的请求体，返回 JSON 编码和 XML 编码的响应，并遵循标准的 HTTP 方法、认证和响应代码。您可以在测试模式和实时模式下使用Dynadot API。所使用的模式由用于认证您请求的API密钥决定。测试模式允许您模拟并验证您的API集成，而不影响实时数据或交易。Dynadot API 主要专注于域名管理、订单处理和相关服务。您可以执行注册、转移和续订域名、管理 DNS 设置以及查看或更新账户订单等操作。请注意：不支持批量创建、更新、删除操作，每种请求类型限制为一个对象或操作。

生成您的 API 密钥在您开始发出任何 API 请求之前，生成您的 API 密钥和 API 密码是必要的。这些密钥是进行身份验证以及在与我们的 API 交互时确保您操作安全所必需的。您可以在账户设置中的 API 部分生成 API 密钥和 API 密码。1. 在 Dynadot 登录您的账户。2. 导航至工具 > API。3. 从这个页面生成您的API 密钥和API 密码。

加入我们的社区有任何想法或建议吗？直接与我们的专业工程师交流。Discord

HTTP 方法API 使用标准的 HTTP 方法来对资源进行操作：

Method	Description
GET	GET Request: Retrieve detailed information about a specified resource
POST	POST Request: Create a new resource
PUT	PUT Request: Fully update the specified resource
DELETE	DELETE Request: Remove the specified resource

URL

所有 API 请求的基础 URL 是：https://api.dynadot.com/

完整的URL格式：http://api.dynadot.com/restful/version_code/resource/{resource_identify}/action

https://api.dynadot.com/restful/v1/domains/{domain_name}/search

版本

当前的 API 版本是v

在构建 API 请求 URL 时，只需包含主版本号即可。次要版本和补丁更新旨在保持向后兼容，不会引入破坏现有代码的更改。这确保了稳定性，同时允许您在不需要修改实现的情况下，从增量改进和修复中获益。当未来版本发布时，我们将在一段时间内保持对旧版本的向后兼容性。新功能和重大更改将在主要版本增量中引入。

HeaderAPI 请求的头部包含了关于请求的元数据。这些元数据为服务器正确处理请求提供了必要的上下文。常用的头部包括：

Content-Type指定请求体中发送数据的格式。服务器使用此信息来正确解析请求。目前唯一接受的值是：application/json。

Content-Type: application/json

接受通知服务器客户端期望的响应格式。可能的值包括：application/json、application/xml

Accept: application/json

授权所有 API 请求都必须包含一个 API 密钥以进行身份验证。您可以从您的账户仪表板获取您的 API 密钥。You can generate an API key in API setting page

Authorization: Bearer YOUR_API_KEY

X-Request-IDX-Request-ID 头是一个可选的头部，用于唯一标识每个 API 请求。包含此头部时，可以帮助跟踪和关联系统及日志中的请求，从而便于调试和监控 API 活动。X-Request-ID 的值必须是有效的UUID（通用唯一识别码），遵循标准格式：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx（例如，123e4567-e89b-12d3-a456-426614174000）。

X-Request-ID: 550e8400-e29b-41d4-a716-446655440000

X-签名X-Signature 头是处理交易请求时必需的安全机制，包括那些检索敏感信息或更新数据的请求。它通过要求客户端使用 HMAC-SHA256 对请求负载进行签名，确保 API 请求的真实性、完整性和不可否认性。

要生成签名，您需要以下值1. API 密钥：您的独特 API 密钥。2. 完整路径和查询参数：API端点的完整路径以及查询参数。3. X-Request-Id：请求 ID。如果不可用，您可以输入空字符串。4. 请求正文：请求的正文部分。如果此部分为空或为 null，您可以输入空字符串。

待签名的字符串是上述值的组合，按以下顺序连接：

apiKey + "\n" + fullPathAndQuery + "\n" + (xRequestId or empty String) + "\n" + (requestBody or empty String)

apiKey = "your_api_key"
fullPathAndQuery = "/v1/some/endpoint?param=value"
xRequestId = "unique-request-id"
requestBody = "{\"key\":\"value\"}"


stringToSign = "your_api_key\n/v1/some/endpoint?param=value\nunique-request-id\n{\"key\":\"value\"}"

生成 HMAC-SHA256 签名在构建签名字符串后，您需要使用您的密钥应用HMAC-SHA256加密。这个过程将生成签名。签名的生成遵循以下步骤：1. 使用 HMAC-SHA256 算法。2. 使用 stringToSign 作为输入消息。3. 使用密钥作为密钥。
将生成的签名用作请求头中X-Signature的值。

X-Signature: {HMAC-SHA256 Signature}

BodyAPI 请求的正文用于向服务器发送数据。它通常包含在 POST、PUT 或 PATCH 请求中（通常不用于 GET 或 DELETE 请求）。

Sure, please provide the specific text you need translated into Chinese Simplified.正文数据的格式由“Content-Type”头部决定。一些常见的格式包括：

{
    "domainName": "domain.com",
    "showPrice": "yes",
    "currency": "USD"
}

典型使用场景POST 请求：POST 方法用于在服务器上创建新资源。请求体通常包含资源的详细信息。PUT 请求：PUT 方法用于通过完全替换来更新现有资源。请求体包含完整的更新资源。GET 请求：DELETE 方法用于从服务器中删除已存在的资源。它不包含请求体。DELETE 请求：GET 方法用于从服务器检索现有资源。它不包含请求体。

Response Format所有 API 响应均以 JSON 或 XML 格式返回，响应体数据的格式由 Accept 头部确定，提供请求的数据或错误信息（如果适用）。

Sure, please provide the specific text you need translated into Chinese Simplified.一般来说，响应包含三个部分：代码、消息、数据。

代码：请求的状态消息：关于状态的更多描述数据：响应的主体内容

{
    "Code": "200",
    "Message": "Success",
    "Data": {}
}

错误处理HTTP状态代码是服务器返回的标准化三位数字，用以指示客户端请求的处理结果。它们提供了关于请求是否成功处理、是否需要进一步操作或是否遇到错误的重要信息。这些代码分为五个类别，每个类别代表一种不同类型的响应。我们的 API 状态代码遵循 HTTP/1.1 协议，这是一个广泛接受的标准，确保了一致且可靠的通信。通过使用 HTTP/1.1，我们利用了如持久连接和增强缓存等功能，以优化客户端与服务器之间的交互。

2xx（成功）：表示命令已接收并被接受。

200状态代码表明请求已成功。

201状态代码表明请求已被满足，并且已创建了一个或多个新资源。

202状态代码表明请求已被接受处理，但处理尚未完成。

249用户在规定时间内发送了过多的请求

4xx（客户端错误）：表示客户端在请求中出现错误，例如提供了无效的输入或缺乏适当的授权。

400状态码表明，由于某些被认为是客户端错误的原因，服务器无法或不会处理该请求。

401状态代码表明，由于缺乏针对目标资源的有效认证凭证，请求未被执行。

402状态代码表明由于支付问题，请求未能执行。

403状态代码表明服务器已理解请求，但拒绝执行。

404状态码表明源服务器没有找到目标资源的当前表示，或者不愿意透露该资源存在。

409由于与资源的当前状态存在冲突，无法完成该请求。

5xx（服务器错误）：表示服务器遇到错误或无法完成请求。

500状态代码表明服务器遇到了一个意外情况，导致它无法完成请求。

501状态代码表明服务器不支持完成请求所需的功能。

502状态代码表明，服务器在充当网关或代理时，从其尝试满足请求时访问的入站服务器收到了无效响应。

503状态代码表明，由于暂时性过载或计划中的维护，服务器目前无法处理请求。这种情况在延迟一段时间后可能会得到缓解。

504状态码表明，服务器在充当网关或代理时，未能及时从其需要访问的上游服务器那里获得响应，以完成请求。

: 代码状态名称

200成功

201创建

202接受了

249请求过多

400错误的请求

401未经授权

402需要付款

403禁止访问

404未找到

409冲突

500内部服务器错误

501未实现

502错误的网关

503服务不可用

504网关超时

速率限制请求应通过 https（安全套接字）发送以确保安全。一次只能处理一个请求，因此请等待当前请求完成后再发送另一个请求。

您的账户价格等级不同，将获得不同的线程数：

Price level	Account
Regular	1 thread
Bulk	5 threads
Super Bulk	25 threads

<Response>
  <status>
    <code>429</code>
    <message>Too Many Requests</message>
  </status>
  <error>
    <description>You have reached the maximum allowed requests within the concurrent limit of your account. Please try again later.</description>
  </error>
</Response>

{
  "code": 429,
  "message": "Too Many Requests",
  "error": {
    "description": "You have reached the maximum allowed requests within the concurrent limit of your account. Please try again later."
  }
}

更改日志概览

更新日志是记录 API 每个版本中变更、改进、修复错误和新功能的详细记录。它通过记录每次更新的影响，为用户和开发者提供透明度。它主要包括两个关键部分：

API 版本本部分介绍了API的版本控制系统，该系统帮助开发者跟踪功能的演变并确保兼容性。每个API版本都有一个独特的版本号（例如，v1.0.1、v2.2.3），代表了一个重要的里程碑或发布。版本控制使用户能够在准备好时选择更新，从而最小化集成的中断。

更改日志历史更改日志历史提供了每个版本中更新、修复错误、弃用和增强功能的详细信息。它详细描述了对端点、参数、认证机制或响应格式所做的具体更改。此部分确保开发者完全了解发生了哪些变化，并可以相应地调整他们的实现。通过维护一个清晰、详细的更改日志，我们旨在为开发者提供管理集成的工具和信息，使他们能够有效且自信地进行管理。

API 版本

我们的 API 目前处于版本v

版本代码用于系统地识别和管理 API 更新。它们遵循语义版本控制（SemVer）格式：

版本代码的每个组成部分都有其特定的目的，并帮助开发者有效地传达更改的范围和类型。

主要版本定义：代表可能破坏向后兼容性的重大变化。Certainly! Please provide the text you need translated into Chinese Simplified.<Major>.x.x

示例:v1.0.0->v2.0.0完全的 API 重新设计或不兼容的架构更改。

次要版本定义：表示向后兼容的功能添加。Certainly! Please provide the text you need translated into Chinese Simplified.x.<Minor>.x

示例:v1.0.0->v1.1.0添加新的端点或方法，同时保持向后兼容性。

补丁版本定义：指向后兼容的错误修复或小幅改进。Certainly! Please provide the text you need translated into Chinese Simplified.x.x.<Patch>

示例:v1.0.0->v1.1.0修复 API 端点中的一个小错误。

API 更新日志

更新日志是一份详细记录，涵盖了软件或API每个版本中的变更、改进、错误修复和新功能。通过记录每次更新的影响，它为用户和开发者提供了透明度。