Introdução

Conheça nossa API de Logística

Esta API tem como objetivo permitir que parceiros de serviços de entrega se integrem diretamente à nossa plataforma, oferecendo soluções terceirizadas de logística as lojas. Com essa integração, as lojas podem chamar entregadores e acompanhar em tempo real o status das entregas dentro da própria Saipos, sem necessidade de alternar entre aplicativos ou redigitar informações de pedidos.

Na construção dessa API, foi utilizado os modelos de dados e chamadas baseados no padrão Open Delivery, uma iniciativa da Abrasel que padroniza a comunicação entre sistemas de gestão, marketplaces e plataformas de logística no ambiente de delivery. O padrão facilita a integração com múltiplos players do mercado, economizando tempo e esforço técnico. Portanto, é necessário que o desenvolvimento seja baseado nesse padrão de comunicação. Para mais informações, acesse a documentação oficial do Open Delivery.

Etapas do processo de Integração


flowchart LR 
Credenciamento --> Desenvolvimento[Desenvolvimento]
 Desenvolvimento --- Homologação[Homologação] 
 Homologação --> Oficialização[Oficialização]

Credenciamento

O primeiro passo é realizar o credenciamento da sua empresa. Para isso, basta preencher o formulário disponível no Saipos Developer.

Após o preenchimento, o sistema disponibilizará automaticamente as credenciais necessárias para que você possa iniciar o desenvolvimento da integração.

Desenvolvimento

Com as credenciais em mãos, você poderá iniciar o desenvolvimento da sua solução. Essa etapa é realizada integralmente em nosso ambiente de desenvolvimento (sandbox), utilizando a loja de testes fornecida para simular pedidos, entregas e atualizações de status.

Durante o desenvolvimento, é fundamental utilizar nossa documentação técnica para entender o comportamento dos endpoints, as regras de negócio envolvidas e os padrões de resposta esperados. Também recomendamos consultar o glossário, onde você encontrará o detalhamento de cada informação trafegada pela API.

Além disso, veja nosso Guia prático de Integração, onde possui o passo a passo de como utilizar a API de Logística na Saipos.

Homologação

Após concluir o desenvolvimento e os testes internos, você deve solicitar a homologação da sua integração. Esse pedido é feito pelo caminho indicado no inicio dessa documentação. Após a solicitação, nosso time enviará os critérios para a integração ser homologada, no qual solicitamos evidências que comprovem o funcionamento correto da solução.

Segue os critérios de homologação: Critérios de Homologação

Nosso time técnico fará a análise dessas evidências e, caso identifiquemos algum ponto fora do padrão esperado, entraremos em contato para que os ajustes necessários sejam realizados antes da liberação da próxima etapa.

Oficialização

Concluído a etapa de homologação com sucesso, sua integração será oficialmente homologada pela Saipos. Nosso time de produto fará alguns combinados do processo de ativação de lojas assim como para possíveis acionamentos de suporte.

A partir desse momento, sua solução poderá ser oferecida ao mercado, e os restaurantes que utilizam nosso sistema poderão ativar a integração diretamente dentro da plataforma. Além disso, você passará a ser reconhecido como um parceiro oficial e poderá ser mencionado em nossos canais de comunicação.

SLAs de Respostas

  • Para homologação de API de Logística, o retorno será dado em até 5 dia útil, através do email informado na abertura da solicitação
  • Para suporte/dúvidas solicitadas de API de Logística, o retorno será dado em até 5 dias úteis, através do email informado na abertura da solicitação