服务器到服务器 OAuth | 文档 | 反向 IP/DNS API | WhoisXML API

服务器到服务器 OAuth

发出 API 请求时,使用服务器到服务器 OAuth 对 WhoisXML API 进行身份验证。这 也被称为 "双脚 OAuth",因为它使用两步流程,不需要用户交互进行 验证或授权。流程如下

  • 服务器到服务器 OAuth 客户端向 WhoisXML API 授权服务器请求访问令牌。
  • 您的客户端使用访问令牌发出 API 请求。

您还可以查看GitHub 上的脚本,了解如何将 WHOIS API 与服务器端 SSO 结合使用。

生成访问令牌

使用 访问令牌授权类型生成访问令牌。这种授权类型的特点是

  • 令牌的生命周期为 1800 秒(30 分钟)、3600 秒(1 小时)、7200 秒(2 小时)或 10800 秒(3 小时)。默认为 3600 秒(1 小时)。
  • 没有刷新令牌。
  • 您可以生成和使用多个访问令牌。
  • 生成新的 API 密钥后,之前生成的所有访问令牌都会失效。
  • 生成的访问令牌对您可以访问的任何产品都有效。

请注意,生成的 访问令牌而不是 apiKey参数。

API端点

职位 https://main.whoisxmlapi.com/oauth/token
curl --location 'https://main.whoisxmlapi.com/oauth/token' \
--header 'Authorization: Bearer %base64_encoded_API_key%' \
--header 'Content-Type: application/json' \
--data '{
    "grantType": "access_token",
    "expiresIn": 7200
}'

页眉

授权

必须填写。Base64 编码的 API 密钥。

验证方案:承载器

"我的产品"页面获取个人 API 密钥。

输入参数

grantType

必须填写。用于生成访问令牌的授权类型。

接受值:access_token

过期

可选项。访问令牌的有效期,以秒为单位。

可接受的值:1800 , 3600 , 7200 , 10800.

默认值:3600

输出格式

选填。结果输出格式。

可接受的值: JSON | XML

默认值: JSON

回应

{
    "accessToken": "G2OIE2AKRCVDYFUJCV5PXXXXXXXXXXXX",
    "expiresIn": 3600
}

使用 访问令牌值来验证 API 请求。将生成的值代入 apiKey字段,就像使用普通 API 密钥一样。

错误

{
    "code": 401,
    "messages": "Access restricted. Check the credits balance or enter the correct API key."
}
{
    "code": 422,
    "messages": {
        "grantType": [
            "The selected grant type is invalid."
        ]
    }
}

使用访问令牌的 cURL WHOIS API GET 请求示例

curl --location 'https://www.whoisxmlapi.com/whoisserver/WhoisService?domainName=google.com' \
--header 'Authorization:Bearer %accessToken%'

使用访问令牌的 cURL WHOIS API POST 请求示例

curl --location 'https://www.whoisxmlapi.com/whoisserver/WhoisService' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer %accessToken%' \
    --data '{
        "domainName": "google.com"
    }'