Autenticação
A autenticação para utilização da API de recuperação de dados do caso é realizada através da estrutura de token de acesso (Access Token). Para isso, é necessário obter o access token através da iam-auth-api:
POST https://api.cvortex.com/v1/auth/
Parâmetros de requisição:
{
"password": "string",
"username": "{subdominio_tenant}\\{username}"
}
Observação: o campo username deve conter o prefixo com o número único do cliente, seguido de uma barra invertida (\) e o nome de usuário.
Exemplo: 12345\nome.sobrenome
Autorização
Após obter o token de acesso, toda requisição aos endpoints das APIs cVortex deve informar esse token no cabeçalho Authorization, para a respectiva autenticação e autorização:
Authorization: Bearer <token>
Content-Type
Tanto as requisições quanto as respostas utilizam o content-type:
application/json
Padronização de valores
-
Os valores de data estão no padrão GMT-0.
-
Filtros de data são sempre intervalos (início e fim).
-
Todas as datas enviadas para a API devem estar em Current Millis (timestamp em milissegundos).
-
Todas as datas retornadas pela API também são em Current Millis.
Limite de Requisições de API (Rate Limit)
Para garantir a estabilidade, a segurança e o bom desempenho da plataforma cVortex para todos os usuários, as APIs possuem um limite de chamadas simultâneas prática conhecida como Rate Limit.
Qual é o limite atual?
O limite estabelecido é de 10 requisições por segundo, por tenant (conta ou ambiente na plataforma).
Isso significa que todos os sistemas ou integrações conectados a uma conta podem realizar, juntos, até 10 chamadas à API a cada intervalo de 1 segundo.
O que acontece se o limite for ultrapassado?
Se o sistema enviar a 11ª requisição dentro do mesmo segundo, a API da cVortex não processará essa chamada imediatamente. Em vez disso, retornará um erro de limitação (geralmente HTTP 429) acompanhado da seguinte mensagem:
"Limite de requisições excedido. Tente novamente em alguns segundos."
Tempo Limite de Resposta (Timeout)
Além do limite de requisições, existe um tempo máximo para que a API conclua o processamento de cada chamada recebida.
Qual é o limite atual?
-
A API dispõe de até 60 segundos para responder a cada requisição recebida.
-
O limite é aplicado por requisição e independe do Rate Limit. Uma chamada pode respeitar o limite de 10 requisições por segundo e ainda assim atingir o tempo máximo de resposta.
O que considerar ao integrar
Ao configurar o sistema que consome esta API, defina um tempo limite compatível com esse valor. Um tempo limite muito curto do lado chamador pode encerrar a conexão antes que a resposta seja concluída, especialmente em consultas que envolvem volumes maiores de dados, como buscas de casos com filtros amplos ou históricos de interação extensos.
Para o tempo limite aplicado quando a plataforma consome APIs externas, consulte Tempos limite das integrações.