HSDesk APIHSDesk / API Pública
ReferenciaGestão (painel)

Criar credencial (HSDesk Key)

O token em texto puro é retornado **uma única vez** na criação. Guarde-o: o servidor só armazena o hash.

POST
/api/api-keys

Authorization

bearerAuth
AuthorizationBearer <token>

Token JWT obtido via POST /api/auth/login

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/api-keys" \  -H "Content-Type: application/json" \  -d '{    "nome": "Integração ERP"  }'
{  "success": true,  "message": "Credencial criada. Guarde o token: ele não será exibido novamente.",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "nome": "Integração ERP",    "key_prefix": "hsk_live_AbCdEf12",    "ativa": true,    "ultimo_uso_em": "2019-08-24T14:15:22Z",    "revogado_em": "2019-08-24T14:15:22Z",    "criado_por": "46c41a58-64f4-436b-bee5-58a42d2eae60",    "criado_em": "2019-08-24T14:15:22Z",    "token": "hsk_live_AbCdEf12GhIjKl34MnOpQr56StUvWx78YzAbCd90"  },  "errors": []}
{  "success": false,  "message": "Erro de validação",  "errors": {    "nome": [      "O campo nome é obrigatório."    ],    "categoria": [      "O campo categoria é obrigatório."    ]  }}
{  "success": false,  "message": "Não autenticado.",  "status": 401,  "data": null,  "errors": {    "field": "token",    "message": "Token ausente, inválido ou expirado."  }}
{  "success": false,  "message": "Acesso negado.",  "status": 403,  "data": null,  "errors": {    "field": "permissao",    "message": "Você não tem permissão para esta ação."  }}