- 홈
- API 문서
API 문서
토큰 기반 인증이 있는 안전한 REST API를 사용하여 암호화된 데이터에 프로그래밍 방식으로 액세스하세요.
시작하기
시작하려면 계정 설정에서 API 키를 생성하세요
Hexbon API를 사용하려면 계정 설정 → API 설정 페이지에서 API 키를 생성해야 합니다. API는 향상된 보안을 위해 2단계 인증 흐름을 사용합니다.
인증 흐름
토큰 요청
API 키를 사용하여 POST /api/v1/auth를 통해 임시 액세스 토큰을 요청하세요
토큰 유효성
토큰은 60분 동안 유효합니다. 만료 후 새 토큰을 요청하세요.
토큰 사용
데이터 작업을 위해 Authorization: Bearer <token> 헤더에 토큰을 포함하세요.
속도 제한
API는 사용자당 분당 10 요청으로 제한됩니다. 이 제한을 초과하면 429 Too Many Requests 응답이 발생합니다.
엔드포인트
인증
https://hexbon.com/api/v1/auth
API 키를 사용하여 임시 액세스 토큰을 생성합니다.
헤더
| X-API-Key | 귀하의 API 키 (필수) |
curl -X POST "https://hexbon.com/api/v1/auth" \ -H "X-API-Key: your_api_key_here"
{
"success": true,
"bearer_token": "abc123def456...",
"expires_at": "2025-11-27T15:30:00Z",
"expires_in": 3600
}
읽기
https://hexbon.com/api/v1/data
암호화된 데이터를 검색합니다. 클라이언트 암호화 페이로드(v1:...)를 반환합니다.
헤더
| Authorization | Bearer <token> (필수) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
업데이트
https://hexbon.com/api/v1/data
암호화된 데이터를 저장합니다. 요청 본문에 클라이언트 암호화 페이로드(v1:...)를 허용합니다.
참고: 쓰기 액세스는 API 설정에서 활성화해야 합니다. 기본적으로 API 액세스는 읽기 전용입니다.
헤더
| Authorization | Bearer <token> (필수) |
| Content-Type | application/json (필수) |
요청 본문
| data | v1:로 시작하는 클라이언트 암호화 페이로드 (필수) |
curl -X POST "https://hexbon.com/api/v1/data" \
-H "Authorization: Bearer your_token_here" \
-H "Content-Type: application/json" \
-d '{"data": "v2:your_encrypted_payload"}'
{
"success": true,
"message": "Encrypted data saved successfully."
}
응답 형식
모든 API 응답은 작업 결과를 나타내는 부울 필드 success가 포함된 JSON 형식으로 반환됩니다.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
오류 코드
| 코드 | 설명 |
|---|---|
| 401 | 유효하지 않거나 누락된 API 키 / 토큰 만료됨 |
| 403 | 쓰기 액세스 비활성화됨 (POST /data의 경우) |
| 422 | 유효하지 않은 페이로드 형식 또는 저장소 제한 초과 |
| 429 | 속도 제한 초과 (10 요청/분) |
| 500 | 내부 서버 오류 |