Introdução
Existem duas APIs expostas pela CustomerX: uma para dados, acessível pelo link https://doc.api.customerx.com.br/ , e outra para tracking, acessível pelo link https://doc.tracking.customerx.com.br/ . A API de dados é destinada ao envio e manutenção de informações cadastrais de clientes, contatos, contratos, tickets, aspectos financeiros, entre outros. Enquanto isso, a API de tracking tem como finalidade registrar eventos de uso enviados pelo cliente, podendo incluir métricas de uso, acesso, logins, entre outros.
1. Quais são os limites de requisições para as APIs expostas?
A API de tracking não possui limite de requisições. Utilizamos uma infraestrutura avançada que permite enfileirar registros para processamento assíncrono. Ao enviar uma requisição é retornado o status 202 que significa que foi recebida com sucesso e enfileirada para ser processada posteriormente.
Para a API de dados, os limites de requisições são definidas por plano, sendo:
Plano Essentials: 30 requisições por minuto.
Plano Startup (descontinuado): 60 requisições por minuto.
Plano Professional e Growth (descontinuado): 120 requisições por minuto.
Plano Enterprise e Scale (descontinuado): 240 requisições por minuto.
2. Como saber se os eventos da API de tracking foram processados com sucesso?
Você pode conferir o status do processado da API de tracking através do menu "Tracking> Logs de tracking"
Os status são divididos em três, sendo:
Em fila: requisição foi recebida em aguarda em fila para processamento.
Processado: a requisição foi processada com sucesso.
Com falha: não foi possível processar a requisição.
Em caso de falha, é possível clicar para expandir o registro no log e conferir o motivo da falha conforme o exemplo abaixo:
3. O que acontece se o limite de requisições for ultrapassado?
Ao ultrapassar o limite, a API retornará o status 429 (Too many requests), indicando que foi atingido o limite de requisições por minuto.
4. É possível reprocessar requisições após ultrapassar o limite?
Sim, caso ocorra um erro de "too-many-requests" ou similar, será responsabilidade do cliente reenviar ou reprocessar as requisições dentro da cadência aceitável pelo plano contratado.
5. É possível expandir o limite de requisições sem alterar o plano contratado?
Não há possibilidade de expandir o limite de requisições sem mudar para um plano superior.
6. Que orientações são recomendadas para os desenvolvedores integrando com as APIs?
Recomendamos que os desenvolvedores monitorem a cadência das requisições para não ultrapassar o limite do plano contratado. Além disso, é importante implementar um tratamento para reprocessar eventos em caso de ultrapassagem do limite e erro no processamento de registros.