A rota de Licenças retorna todas as licenças de um contrato no novo Portal do Cliente.
Autenticação — Gerar JWT temporário
Antes de chamar qualquer rota de licença, é necessário obter um JWT temporário via token de API. O JWT expira em 30 minutos (1800 segundos); após isso, repita o login.
Método: POST
https://api.clientes.tecnospeed.com.br/v1/usuarios/auth/login-api-token
Header:
| Nome | Valor |
| Content-Type | application/json |
Body (JSON):
{
"documento": "29062609000177",
"token": "seu-token-de-api"
}
Caso não saiba como obter o token de API, consulte o artigo Como conseguir o Token.
Resposta 201:
{
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expiresIn": 1800
}
URL e Requisição — Listar Licenças
A rota de licenças exige o método GET. O :idContrato é o identificador numérico do contrato, visível na interface do Portal do Cliente.
https://api.clientes.tecnospeed.com.br/v1/contratos/:idContrato/licencas
Headers
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de conteúdo | application/json |
| Authorization | JWT obtido no login-api-token (prefixo Bearer) | Bearer eyJhbGci... |
Query Params (opcionais)
| Nome | Descrição |
| situacao | Filtrar por situação: Ativo, Inativo ou Bloqueado
|
| razaoSocial | Filtrar por razão social (busca parcial) |
| cnpj | Filtrar por CNPJ da licença |
| periodoInicio | Data inicial (AAAA-MM-DD) |
| periodoFim | Data final (AAAA-MM-DD) |
| _page | Número da página (padrão: 1) |
| _limit | Itens por página (padrão: 10) |
Retorno
Exemplo de retorno (200):
{
"data": [
{
"id": "98765",
"cnpj": "12345678901234",
"razaoSocial": "EMPRESA LICENCIADA LTDA",
"dataInicial": "2023-06-01",
"dataFinal": null,
"situacao": "Ativo",
"motivoInativacao": null,
"contrato": { "id": "12345", "situacao": "Ativo" },
"produto": { "id": "2652", "codigo": "50", "nome": "Plataforma Manager eDoc" }
}
],
"meta": {
"itemCount": 1,
"totalItems": 1,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
}
}
Exemplos de retorno com erro:
401 — JWT expirado ou ausente
401 — { "message": "Token inválido para o documento informado" }
403 — { "message": "Usuário não possui permissão para acessar este recurso" }
404 — { "message": "Contrato não encontrado" }
Comentários
0 comentário
Por favor, entre para comentar.