API Key Gestão

Ver como Markdown

API Key endpoints de gerenciamento aceitam apenas autenticação JWT .

Crie API Key

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

Parâmetros da solicitação:

ParâmetroTipoObrigatórioDescrição
labelstringSimAPI Key etiqueta, comprimento 1 - 64
permissionsintNãoMáscara de permissão, 1padrão, intervalo 1 - 7
ipWhitelistfio[]NãoIP whitelist, até 20 entradas. Se omitido, o IP fonte é irrestrito

Exemplo de pedido:

$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"]
> }'

Exemplo de resposta:

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

apiSecret é retornado apenas uma vez quando o API Key é criado. Armazene imediatamente em um sistema de gerenciamento secreto. Não escreva em repositórios ou logs do código-fonte.

Cada usuário pode criar até 30 API Chaves.

Lista API Chaves

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

Campos de resposta:

CampoTipoDescrição
list[].idstringAPI Key ID
list[].labelstringSelo
list[].apiKeystringIdentificador público API Key
list[].permissionsintMáscara de permissão
list[].ipWhitelistfio[]IP lista branca
list[].statusintStatus: 1 ativado, 0 desativado
list[].lastUsedAtint64Último tempo usado
list[].createdAtint64Tempo de criação

Atualização API Key

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

Parâmetros da solicitação:

ParâmetroTipoObrigatórioDescrição
idstringSimAPI Key ID
labelstringNãoNova gravadora
permissionsintNãoNova máscara de permissão
ipWhitelistfio[]NãoLista branca de novos IP
statusintNão1 ativado, 0 desativado

Exclua API Key

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

Órgão do pedido:

1{ "id": "1001" }

Exclua Todas as Chaves API

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

Campos de resposta:

CampoTipoDescrição
deletedint64Número de chaves de API excluídas