Essa rota deve ser utilizada quando precisar inativar uma licença já cadastrada/ativada no Portal do Cliente.
Autenticação — Gerar JWT temporário
Antes de chamar a rota de inativação, é 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
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 — Inativar Licença
A rota de inativação exige o método PATCH. Substitua :idContrato pelo id do contrato e :cnpj pelo CNPJ a ser inativado.
https://api.clientes.tecnospeed.com.br/v1/contratos/:idContrato/licencas/documento/:cnpj/inativar
Caso não saiba como encontrar o id do contrato, ele é exibido na interface do Portal do Cliente.
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... |
Body
| Nome | Descrição |
| motivoInativacao | Descrição do motivo de inativação da licença |
Exemplo de body:
{
"motivoInativacao": "Inativado por solicitação do cliente"
}
Retorno
Retorno de sucesso: 204 No Content (sem body).
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.