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
登入／權杖、使用者資訊的取得與更新、操作紀錄、聯絡人（contact）管理、聯盟行銷資訊等。
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 確認最新的定義。
