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

Listar credenciais da API pública

Endpoints de gestão da API Pública, usados pelo painel para gerenciar credenciais e webhooks. Autenticados por JWT do painel com a permissão api_publica:gerenciar (diferente da API v1 de parceiros, que usa HSDesk Key).

GET
/api/api-keys

Authorization

bearerAuth
AuthorizationBearer <token>

Token JWT obtido via POST /api/auth/login

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/api-keys"
{  "success": true,  "message": "Credenciais listadas.",  "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"    }  ],  "errors": []}
{  "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."  }}