認証と署名

API Key 管理

Markdownとして表示

API Key 管理エンドポイントは認証のみ JWT 受け付けます。

創り出す API Key

1POST /v1/private/user/api-key/create
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

リクエストパラメータ:

パラメータ種類必須概要
labelstringはいAPI Key ラベル、長さ1 - 64
permissions知力いいえ許可ビットマスク、デフォルト 1、範囲 1 - 7
ipWhitelistストリング[]いいえIP ホワイトリスト、最大20件まで。省略の場合、出典 IP は制限なしです

依頼例:

$curl -X POST https://api.6mm.com/v1/private/user/api-key/create \
>  -H "Content-Type: application/json" \
>  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
>  -d '{
>    "label": "external-service-prod",
>    "permissions": 3,
>    "ipWhitelist": ["203.0.113.10"]
>  }'

回答例:

1{
2  "code": 0,
3  "message": "success",
4  "data": {
5    "apiKey": "fx_xxxxxxxxxxxxxxxxxxxxxxxx",
6    "apiSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
7  },
8  "requestId": "req-api-key"
9}

apiSecret は API Key が作成される際に一度だけ返されます。すぐに秘密管理システムに保存してください。ソースコードリポジトリやログには書き込みしないでください。

各ユーザーは最大30個の API キーを作成できます。

API 一覧

1GET /v1/private/user/api-key/list
2Authorization: Bearer YOUR_ACCESS_TOKEN

応答フィールド:

フィールド種類概要
list[].idstringAPI Key ID
list[].labelstringレーベル
list[].apiKeystringパブリック API Key 識別子
list[].permissions知力許可ビットマスク
list[].ipWhitelistストリング[]IP ホワイトリスト
list[].status知力ステータス: 1 有効、 0 無効
list[].lastUsedAtint64最後の使用時間
list[].createdAtint64作成時間

アップデート API Key

1PUT /v1/private/user/api-key/update
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

リクエストパラメータ:

パラメータ種類必須概要
idstringはいAPI Key ID
labelstringいいえ新しいレーベル
permissions知力いいえ新しい権限ビットマスク
ipWhitelistストリング[]いいえ新しい IP ホワイトリスト
status知力いいえ1有効、無効0

削除 API Key

1POST /v1/private/user/api-key/delete
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

要請本体:

1{ "id": "1001" }

すべての API キーを削除してください

1POST /v1/private/user/api-key/delete-all
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

応答フィールド:

フィールド種類概要
deletedint64削除された API キーの数