Client Portal Guide
客户门户：API 对接指南 #
BESTNET-CLOUD 的客户门户提供 HTTP REST API。您可以通过程序自动化地查询和操作账户信息及已签约的服务。所有响应均以 JSON 返回。
前提条件 #
- 能够登录客户门户
- 使用 API 的账户对目标服务具有访问权限
- 通信务必使用 HTTPS（不要以明文发送认证信息）
API 基础 #
基础 URL
https://hb.bestnetllc.co.jp/api/ 之下提供了各个方法。
数据格式
请求为 HTTP（GET / POST / PUT / DELETE），响应为 JSON。
交互式参考文档
通过门户左侧菜单的 “API”，可以查看全部方法以及 bash / php / python 的代码示例。
认证 #
API 支持 Basic 认证。将客户区的邮箱地址和密码用 :（冒号）连接，并将经过 Base64 编码后的值通过 Authorization 请求头发送。
# -u オプションでリクエストごとに認証情報を送信します
curl 'https://hb.bestnetllc.co.jp/api/details' \
-u "your-email@example.com:your-password"如需使用令牌，可通过 POST /login 获取令牌，通过 POST /token 刷新，通过 POST /revoke 吊销。
打开 API 参考文档 #
1. 打开门户左侧菜单的“API” #
- 登录客户门户。
- 点击左侧菜单下方的 “API”。
- 会打开 API Reference。在左侧菜单选择方法，即可在右侧窗格查看所需的参数以及 bash / php / python 的代码示例。
- 还可以通过画面上方的 download 获取 用于 Swagger 的 JSON。
可用的主要方法组 #
API 由按用途分类的约 135 个方法构成。
Clientarea
登录／令牌、用户信息的查询与更新、操作日志、联系人管理、联盟（Affiliate）信息等。
Billing
查询账单、付款、信用余额等与付款相关的信息。
Services
获取已签约服务的列表与详情，以及与服务相关的操作。
Domains
获取域名列表与详情，以及与域名相关的操作。
SSL Certificates
查看与管理 SSL 证书。
Support
获取、创建与回复工单。
Cart
创建与确认新订单（购物车）。
DNS
获取与管理 DNS 区域和记录。
请求示例 #
以下是几个具有代表性的端点示例。完整列表与参数请参阅门户的 API Reference。
| 用途 | 方法 | 路径 |
|---|---|---|
| 获取账户信息 | GET | /api/details |
| 登录（获取令牌） | POST | /api/login |
| 获取操作日志 | GET | /api/logs |
| 获取联系人列表 | GET | /api/contact |
| 添加联系人 | POST | /api/contact |
# アカウント情報（details）を取得する例
curl 'https://hb.bestnetllc.co.jp/api/details' \
-u "your-email@example.com:your-password"注意事项 #
必须使用 HTTPS
为保护认证信息，调用 API 时务必使用 HTTPS。
权限范围
可查询和操作的范围取决于登录账户的权限以及您的签约内容。
生产操作注意
创建、更新、删除类的方法会作用于真实数据。请在充分验证后再使用自动化脚本。
故障排查 #
返回 401 Unauthorized
请确认邮箱地址／密码，或 Base64 编码结果是否正确。Basic 认证请求头的格式为 Authorization: Basic <base64>。
不返回 JSON／返回 HTML
请确认端点路径以及是否使用了 HTTPS。对于需要登录的方法，认证信息是必需的。
找不到方法
路径和参数可能会更新。请在门户的 API Reference 中确认最新的定义。
