Nesta seção, você encontra as respostas para as dúvidas mais comuns sobre o uso da API de Dados
Posso filtrar dados de uma venda específica?
No momento, não existe um endpoint dedicado para buscar informações de uma venda específica.
É possível filtrar informações de uma loja específica?
Atualmente, não há suporte para filtro por loja em nenhum endpoint da API de Dados.
Pode haver atraso no recebimento das dados?
Sim. Em períodos de maior volume de processamento, pode ocorrer um delay no envio de dados, ficando disponível somente no D+1.
Quando usar token para uma única loja?
O token de loja única concede acesso exclusivo aos dados de uma única loja. Nesse modelo, cada loja gera sua própria chave de acesso, e caso seja necessário integrar várias lojas, o parceiro deverá armazenar múltiplos tokens e consultar os dados de cada loja separadamente.
Essa abordagem oferece mais segurança, pois, em caso de vazamento, basta revogar o token comprometido sem afetar as demais lojas. Além disso, recomenda-se utilizar um token por integração, evitando que problemas em uma aplicação impactem outras. Para redes e franquias, também é indicado manter um token por loja, sem diferença de custo em relação ao uso de um token compartilhado.
Quando usar token para várias lojas?
O token para várias lojas pode ser usado por redes ou franquias que desenvolvem integrações próprias (ex.: dashboards exclusivos). Já para parceiros que vendem soluções genéricas de BI, deve ser gerado um token por loja. Esse modelo facilita o desenvolvimento interno, mas exige menos segurança, pois todas as lojas pertencem ao mesmo grupo e a alteração de token impacta apenas essa rede.
A API possui rate limit de chamadas de requisições?
A API de dados tem um rate limit de chamadas de 8.500 requisições por minuto por IP, essa restrição é por IP, ou seja, levamos em conta todas as requisições que seu sistema faz para a Saipos, isso independente de tokens/lojas diferentes.
A API possui range limite de consulta de dados?
A API de dados tem um range limite de até 15 dias, entre data inicial e data final, consultas acima disso, serão bloqueadas, por isso, não é possível recuperar todo o histórico de pedidos de uma só vez, desencorajamos fortemente esse tipo de uso.
Regiões e Provedores Permitidos
Atualmente, por questões de segurança e governança de dados, a API de Dados permite conexões originadas exclusivamente de servidores localizados no Brasil e nos Estados Unidos. No momento, não há previsão de liberação para novas regiões geográficas.
AWS Regions (us-east-1 vs eu-central-1)
us-east-1: As requisições originadas desta região já devem estar liberadas para acesso, visto que se encontra em território americano.
eu-central-1: O acesso para esta região não será liberado, seguindo as diretrizes rígidas de segurança e infraestrutura da nossa API.
observação: Não existe alguma configuração de whitelist de IP que possamos liberar no momento.