API Key Gestão | 6MM Docs

API Key endpoints de gestão só aceitam autenticação JWT .

Crie API Key

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

Parâmetros do pedido:

Parâmetro	Tipo	Obrigatório	Descrição
`label`	string	Sim	API Key rótulo, comprimento 1 - 64
`permissions`	int	Não	Máscara de bits de permissões, `1`padrão, intervalo `1` - `7`
`ipWhitelist`	fio[]	Não	IP whitelist, até 20 entradas. Se omitido, a IP de origem é irrestrita

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 é devolvido apenas uma vez quando o API Key é criado. Guarde-o imediatamente num sistema de gestão secreto. Não o escrevas em repositórios ou logs do código-fonte.

Cada utilizador pode criar até 30 API Chaves.

Lista API Chaves

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

Campos de resposta:

Campo	Tipo	Descrição
`list[].id`	string	API Key ID
`list[].label`	string	Editora
`list[].apiKey`	string	Identificador público API Key
`list[].permissions`	int	Máscara de bits de permissão
`list[].ipWhitelist`	fio[]	IP lista branca
`list[].status`	int	Estado: `1` ativado, `0` desativado
`list[].lastUsedAt`	int64	Última utilização
`list[].createdAt`	int64	Tempo de criação

Atualização API Key

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

Parâmetros do pedido:

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	API Key ID
`label`	string	Não	Nova editora
`permissions`	int	Não	Nova máscara de permissão
`ipWhitelist`	fio[]	Não	Lista branca de novos IP
`status`	int	Não	`1` ativado, `0` desativado

Apagar API Key

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

Órgão do pedido:

1 { "id": "1001" }

Apagar Todas as API Teclas

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