APIドキュメント
トークンベースの認証を備えた安全なREST APIを使用して、暗号化されたデータにプログラムでアクセスします。
章
はじめに
開始するには、アカウント設定でAPIキーを生成してください
Hexbon APIを使用するには、アカウント設定 → API設定ページからAPIキーを生成する必要があります。APIは、セキュリティ強化のために2段階の認証フローを使用します。
認証フロー
トークンをリクエスト
APIキーを使用して、POST /api/v1/auth経由で一時的なアクセストークンをリクエストします
トークンの有効性
トークンは60分間有効です。有効期限が切れたら、新しいトークンをリクエストしてください。
トークンを使用
データ操作のために、Authorization: Bearer <token>ヘッダーにトークンを含めます。
レート制限
APIは、ユーザーごとに1分あたり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 | 内部サーバーエラー |