Todas as coleções
Sobre a Intelipost
Para começar
Melhores práticas para consumo de nossa API
Melhores práticas para consumo de nossa API

Confira quais são as melhores práticas para o consumo de nossa API

W
Escrito por William Mansini de Oliveira
Atualizado há mais de uma semana

Considere divulgar essas informações para sua equipe de Tecnologia e, caso queira saber mais sobre integrações e serviços disponíveis em nossa API bem como testar estes serviços, consulte a documentação da nossa API.

1. Timeout

As API’s Intelipost possuem alta eficiência no tempo de resposta, como por exemplo, nossa API de cotação normalmente responde em menos de 100ms. Há alguns fatores que podem influenciar na latência, seja por algum problema no servidor, volumetria ou internet/rede. Pensando nisso, aconselhamos como boa prática configurar timeout na média de 1.5 segundos para evitar a necessidade de retentativas e evitar extra load.

2. Retentativa

Devido à configurações mais simples, nos deparamos com diversos loops com insucessos que podem ser evitados com a utilização de um algoritmo Exponential Backoff*, que fará um trabalho de organizar as retentativas sem ocasionar o extra load no servidor. Esse algoritmo vai incluir um delay extra no sleep para que as retentativas tenham um espaçamento maior e o load no servidor seja distribuído de forma performática, atendendo as demais requisições sem riscos de serem bloqueadas.

Obs: se o sistema que você utiliza atualmente for altamente distribuído, pode ser necessário implementar um mecanismo mais centralizado para obter o próximo delay.

*Exponential backoff é um algoritmo que usa feedback para diminuir multiplicativamente a taxa de algum processo, a fim de encontrar gradualmente uma taxa aceitável.

3. Configurações

Estabeleça prazos para que as configurações e alterações dos seus sistemas integradores sejam congeladas até uma determinada data. Dessa forma você terá planejado o fluxo correto das integrações e garantirá a melhor performance possível com as nossas APIs.

Respondeu à sua pergunta?