Este artigo responde às principais perguntas de quem quer integrar um sistema parceiro à MaisEntregas por API.

Perguntas e respostas

1. Onde encontro a documentação da API de integração? A documentação está neste link: https://docs.google.com/document/d/1rlo0k7mXyFl5YCizjinI5JMth13sWi8HNGEnOfL8UBk/edit

2. Quem deve fazer a integração entre o sistema parceiro e a MaisEntregas? O ideal é que a integração seja iniciada pelo time de desenvolvimento do sistema parceiro, porque o fluxo começa com ele enviando os dados do pedido para a MaisEntregas. Segundo a equipe, a API é simples e costuma ser integrada em poucas horas. Envie a documentação (pergunta 1) ao parceiro e peça que ele inicie a integração.

3. Por que é melhor que o sistema parceiro envie os pedidos, e não a MaisEntregas consultar? A MaisEntregas fica "esperando" os pedidos chegarem. Assim não é preciso consultar o sistema parceiro de tempos em tempos para ver se há pedido novo. Por isso é preferível que o parceiro envie o pedido à MaisEntregas.

4. Posso integrar com qualquer sistema? Sim. A API é aberta. Ela recebe os dados de um pedido ou venda de outro sistema, gera uma corrida (OS) na MaisEntregas e devolve ao sistema integrado o status da corrida (entregador alocado, horários, status, fotos etc.).

5. Se o sistema parceiro não puder fazer a integração, a MaisEntregas faz? Em alguns casos, sim, principalmente em integrações importantes ou estratégicas, após análise. Trata-se de serviço pago. Para isso:

  1. Envie a documentação da API do sistema parceiro.
  2. Abra um ticket nos canais de Suporte (indicados abaixo) para o time de Tecnologia avaliar.
  3. A equipe retornará com custo, prazo e, se necessário, pedirá mais detalhes ao parceiro.

A análise da documentação também é cobrada como orçamento. Se a integração for contratada, o valor do orçamento é descontado do serviço.

6. Como tiro dúvidas técnicas sobre a integração? Formalize a dúvida por escrito ao time de Suporte. Ele encaminha a dúvida ao time de Tecnologia e depois repassa a resposta a você.

7. Quais dados devo enviar para "gerar o pedido"? Envie no "body" todas as informações marcadas como obrigatórias (requeridas) na documentação.

8. O campo "client" é o e-mail do cliente? Não está confirmado. Pelo texto original, "client" é o e-mail do cliente da sua operação.

9. O valor da entrega é o campo "value" dentro de "billing"? Sim. Esse campo deve conter o valor já calculado da corrida.

10. Os endereços em "address" devem seguir uma ordem? Sim. Envie primeiro o endereço de retirada e depois o de entrega, nessa ordem, para que o entregador siga o roteiro. Depois é possível alterar a sequência pela plataforma.

11. O cancelamento pode ser feito a qualquer momento?

  • O usuário administrador da sua operação pode cancelar a qualquer momento.
  • O usuário cliente solicitante só pode cancelar se a corrida ainda não estiver em andamento.

12. Por que recebo o erro error.address.notFound – Endereço #2 não foi localizado e como corrigir? O erro significa que o endereço informado (por exemplo, o de entrega, número 2) não foi encontrado na base da API nem no Google Maps, que é usado como consulta secundária. Hoje não há endpoint para cadastrar ou validar endereços antes do envio.

Para evitar o erro, use uma das alternativas:

  1. Envie latitude e longitude junto com o endereço, como indicado na documentação da API.
  2. Pesquise o endereço no Google e informe-o exatamente como o Google retorna, com endereço completo e formatado corretamente.

Mesmo seguindo essas recomendações, não há garantia de localização, porque a pesquisa pela API é diferente da pesquisa feita diretamente no Google.

Vídeo

Para mais detalhes, assista ao vídeo: ::youtube:k1EF-9CjbXk

Suporte

Se ainda tiver dúvidas, entre em contato com o Suporte: