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
ログイン／トークン、ユーザー情報の取得・更新、操作ログ、連絡先（コンタクト）管理、アフィリエイト情報など。
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 で最新の定義をご確認ください。
