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에서 최신 정의를 확인하십시오.
