Consultar status de Atendimentos via API
Confira a documentação de uso da API para consultar o status de um protocolo de atendimento.
Pré-requisitos
Para utilizar esta API existe a seguinte regra:
- O usuário precisa ter em seu perfil a permissão Consultar status de atendimento via api.
Para liberar o acesso basta acessar: Administração > Usuários > Perfil, escolher o perfil desejado e então habilitar a permissão Consultar status de atendimento via API.
Autenticação de usuário
Para autenticar um usuário na plataforma, utilize o seguinte endpoint: /api/usuario/login
No retorno com sucesso para o método post será exibido uma mensagem contendo o token de acesso aos demais endpoints dessa API.
| Parâmetros no JSON | Descrição |
|---|---|
|
login |
Credencial de acesso do usuário na plataforma com permissão para alterar status de atendimentos
|
|
senha |
Credencial de autenticação do usuário na plataforma com permissão para alterar status de atendimentos
|
Body
{
“login”: “user.api”,
“senha”: “1234”
}
O retorno da chamada para o endpoint poderá ser um dos status a seguir:
SUCESSO
- Access token: código do token
ERRO
- Usuário não encontrado
- Senha inválida
- Houve um problema para gerar um token
- Este campo é obrigatório – login
- Este campo é obrigatório senha
- Access denied (Usuário sem permissão)
- Token is missing (Request sem token)
- JWT expired at ano-mes-data-hora Current Time: ano-mes-data-hora, a difference of number milliseconds. Allowed clock skew: number miliseconds. (Token expirado)
- *JWT signature does not match locally computed signature. JWT validity cannot be asserted and should not be trusted. (Token com falha)
Consultar status de um Protocolo do Atendimento
Para consultar status de um protocolo de atendimento na plataforma, utilize o seguinte endpoint: api/atendimentos/status/numerodoprotocolo
No endpoint numerodoprotocolo deve ser informado o número do protocolo do Citrus para realizar a consulta.
Este endpoint poderá ser usado para consultar protocolos de atendimento com os seguintes status:
- Aberto
- Em atendimento
- Cancelado
- Improcedente
- Finalizado
- Aguardando retorno
Exemplo de Requisição
Exemplo de Retorno
{
“protocolo”: “202301024000001”,
“status”: “Finalizado”,
}
O retorno da chamada para o endpoint poderá ser um dos status a seguir:
SUCESSO
- [200] Message: Atendimento atualizado com sucesso
ERRO
- [404] Atendimento não encontrado
- [403] Access denied
