Integrações e API

Quais integrações a OptiRoutes oferece?

Como carregar pedidos de um arquivo, FTP ou SFTP

A integração mais simples é o arquivo que o seu sistema já exporta. Na tela de pedidos, Carregar entregas lê um arquivo Excel ou CSV; você associa uma única vez cada campo do sistema — endereço, nome do cliente, número do pedido, quantidade e assim por diante — ao nome da sua coluna, e todo arquivo posterior é carregado da mesma forma. Para um arquivo TXT de largura fixa, você informa as posições dos caracteres em vez dos nomes das colunas. É possível ignorar linhas por uma palavra-chave nas observações, uma segunda palavra-chave pode substituir o endereço, e você decide se um número de pedido existente é atualizado ou adicionado como novo.

Para tirar as pessoas do processo, escolha um método de carregamento automático nas configurações:

• O servidor de arquivos da OptiRoutes — o seu sistema deposita o arquivo diário, nomeado pela data, na pasta da sua empresa no servidor FTP ou no servidor SFTP criptografado.
• O seu próprio servidor FTP — a OptiRoutes se conecta com o usuário que você fornecer e carrega o arquivo com a data de hoje no nome ou o arquivo atualizado mais recentemente.
• Importação e exportação automáticas — os pedidos entram sozinhos e as rotas também são planejadas, sem nenhum clique.
• A Files API — o seu software envia o arquivo de pedidos por HTTPS, conforme descrito abaixo.

Na tela de clientes, um arquivo Excel ou CSV com número do cliente, nome, endereço, tempo de parada e horários de abertura e fechamento cria ou atualiza os clientes e as suas janelas de horário.

A Files API: pedidos entrando, PODs e relatórios saindo

Cada empresa na OptiRoutes tem a própria pasta privada de arquivos: os pedidos que carrega, as notas de entrega assinadas com fotos e assinaturas, as exportações de rotas e os relatórios de fim de dia. A Files API permite que os seus sistemas leiam e gravem nessa pasta diretamente por HTTPS, sem servidor FTP no meio. O gerente da empresa alterna entre FTP e a API em Configurações → API e arquivos e cria as chaves ali mesmo — não é preciso pedir ao suporte, e as empresas novas já começam na API.

As chamadas cobrem a verificação da chave, a listagem de uma pasta, o download, o upload (até 50 MB por arquivo) e a exclusão dos arquivos que você enviou, a listagem dos arquivos de POD de um dia por pedido e tipo e o download de todos os arquivos de POD de um dia em um único ZIP. O guia traz exemplos de código em Python, C# e Node.js, além de um script PowerShell que mantém uma pasta do seu servidor sincronizada com a pasta da empresa — para que uma equipe acostumada ao FTP continue trabalhando do mesmo jeito. Leia o guia da Files API.

Como as chaves de API são protegidas?

• Privilégio mínimo — cada chave recebe apenas as permissões de que precisa: só PODs assinados, leitura de todos os arquivos ou upload de pedidos e de arquivos da inbox.
• Endereços autorizados — uma chave pode ser limitada aos endereços IP fixos do seu servidor.
• Validade e rotação — uma chave pode expirar após um número de dias; crie uma chave nova, faça a troca e depois revogue a antiga, sem interrupção.
• Revogação imediata — uma chave revogada para de funcionar em até 30 segundos.
• Auditoria — cada chamada é registrada com horário, endereço, arquivo e resposta, e exibida ao gerente.
• Armazenamento seguro — a OptiRoutes guarda apenas uma impressão digital SHA-256 de cada chave; as conexões usam HTTPS com TLS 1.2 ou superior, e uma chave só acessa a pasta da própria empresa.

Limites: 300 requisições por minuto por chave, 50 MB por arquivo, 20 chaves ativas por empresa e até 5.000 itens em uma listagem de pasta.

A API de relatórios e de envio

Para ferramentas de relatórios e conectores de ERP, uma API separada em api-users.optiroutes.com fornece os dados da sua empresa como relatórios e aceita dados enviados. Um único endereço e um único token, emitidos pela OptiRoutes para a sua empresa, cobrem todas as chamadas. A página de documentação permite colar o seu token e ver quais relatórios estão disponíveis para você e o mapeamento de colunas da sua conta: leia a documentação da API.

Duas chamadas de envio funcionam no sentido inverso: enviar pedidos grava o arquivo de pedidos do dia e inicia o carregamento automático, e enviar motoristas, linhas e veículos substitui a frota inteira, como um arquivo de frota. Como a lista de motoristas enviada conta como a frota completa, envie sempre todos os motoristas, e não apenas as alterações.

Exportação de rotas e webhooks

A exportação de rotas grava as rotas marcadas em CSV, XLSX, XML, JSON ou TXT de largura fixa. Uma tabela de colunas define quais campos saem e com qual cabeçalho, é possível acrescentar colunas originais do seu arquivo de pedidos e, com a gestão de itens, um segundo arquivo lista todos os itens. As exportações podem ir para o seu computador, para o seu servidor FTP ou para a pasta da empresa, e, em JSON, também podem ser enviadas a um endereço web; se o envio falhar, o sistema tenta mais uma vez.

Para cada entrega no momento em que acontece, preencha o endereço de relatórios de entrega nas configurações do app do motorista: cada relatório de entrega feito pelos motoristas também é enviado para lá, de modo que outro sistema seu se atualiza sozinho.

E-mail, pagamentos, mapas e mensagens

• E-mail — as notas de entrega assinadas saem da sua própria conta Gmail com uma senha de app do Google; relatórios como o de paletes do fim do dia vão para o seu e-mail de relatórios; os clientes pagantes recebem recibos e os motoristas, confirmações de depósito do Caixa.
• Pagamentos — as recargas são pagas em uma página de pagamento segura da Stripe, com cartão salvo opcional para a recarga automática.
• Endereços e mapas — os endereços são escolhidos entre as sugestões do Google e verificados no mapa antes do planejamento.
• Navegação — o app do motorista passa cada parada ao Waze, ou ao Apple Maps no iPhone, por endereço ou por coordenadas exatas.
• SMS e WhatsApp — mensagens de chegada e links de acompanhamento aos clientes, alertas aos gestores, linhas aos subcontratados e imagens de rotas aos motoristas pelo WhatsApp.

Perguntas frequentes