Boas práticas de uso da API v1

Abordaremos as principais formas de uso de nossa API, bem como boas práticas, dicas, vantagens e desvantagens de cada uso.

Antes de prosseguir com a leitura, é necessário o conhecimento técnico sobre o funcionamento de nossa API. Acessa a documentação e saiba mais.

Requisições Diretas

Desta forma, você realiza consultas diretas no endpoint da API, sem se preocupar com desenvolvimento back-end, ideal para o front-end:

Por segurança, você precisa gerar o token para cada IP de sua aplicação. Nunca gere um token * (para todos os IPs), pois deixará sua conta aberta para consultas em servidores externos. Assim, você evita o uso indevido de seus créditos por terceiros.
Crie uma rota em seu mapeamento de URLs para que o token não fique exposto.

Também recomendamos o uso de captchas para que não seja possível a injeção de crawlers em sua aplicação:

Vantagens:

• Rápida integração;
• Não requer desenvolvimento back-end;

Desvantagens:

• Dificulta o controle das consultas feitas;

Requisições Internas

A modalidade mais usada, consiste em realizar consultas via back-end, antes de enviá-las para o front-end. Ou, apenas consultas no back-end:

Você poderá usar o token * (para todos os IPs), ideal para serviços como Google Cloud e AWS em que o IP é dinâmico.

Vantagens:

• Flexibilidade em controlar as requisições feitas pela aplicação, bem como limites por usuário;
• Possibilita a criação de APIs internas em sua aplicação para diferentes usos;
• Poderá usar o mesmo token para todo ecossistema;

Desvantagens:

• Maior tempo de integração;

Recomendação Geral:

Para que não haja interação direta dos dados retornados com o usuário final (como, por exemplo, em um formulário de cadastro), recomendamos uma validação inicial por e-mail ou SMS. Dessa forma, os dados só são consultados após o pré-cadastro e validação de reCaptcha, evitando consultas externas não autorizadas. Para aprimorar ainda mais o seu código, é recomendável incluir um tempo de espera entre as consultas, caso o usuário informe um CPF/CNPJ válido e queira alterar logo em seguida.