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
permissionsintНетБитовая маска разрешения, по умолчанию 1, диапазон 1 - 7
ipWhitelistString[]Нет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[].permissionsintБитовая маска разрешения
list[].ipWhitelistString[]IP белый список
list[].statusintСтатус: 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НетНовый лейбл
permissionsintНетНовая битовая маска разрешения
ipWhitelistString[]НетНовый IP белый список
statusintНет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 ключей