Perguntas Frequentes

A Seller Public API e a interface oficial que permite que parceiros integrem seus sistemas ao Ze Delivery, possibilitando operacoes como:

• Recebimento e gestao de pedidos
• Atualizacao de catalogo, produtos, precos e disponibilidade
• Integracao logistica
• Consulta de eventos e status
• Gestao de lojas

Ela foi projetada para suportar multiplos modelos de negocio e integracoes escalaveis.

Empresas que possuam, obrigatoriamente:

• Sistema proprio, como OMS, WMS, ERP ou marketplace
• Capacidade tecnica de integracao via API, a ser validada pelo time tecnico do Ze Delivery
• Acordo comercial com o Ze Delivery

O processo segue estas etapas:

1. Aprovacao da integracao pelo time comercial do Ze
2. Pre-onboarding com validacao tecnica pelo time tecnico do Ze
3. Kickoff tecnico e liberacao de credenciais em ambiente de testes
4. Desenvolvimento e teste da integracao pelo integrador, conforme a documentacao
5. Homologacao e aprovacao dos testes pelo time tecnico do Ze
6. Liberacao de credenciais em producao
7. Go-live controlado, alinhado com o time comercial do Ze
8. Rollout alinhado com o time comercial do Ze

Sim. URLs base:

• Development: https://seller-public-api.release.ze.delivery
• Production: https://seller-public-api.ze.delivery

Sim. E necessario alinhamento com o time comercial para aprovacao da integracao. Se aprovado, o time comercial direciona o contato do time tecnico para o inicio das atividades.

As credenciais em ambiente de teste e de producao sao fornecidas pelo time tecnico do Ze durante o onboarding.

A Seller Public API utiliza OAuth2 no fluxo client_credentials.

1. Envie client_id e client_secret para o endpoint /auth
2. A API retornara um access_token
3. Utilize esse token nas proximas requisicoes

O token precisa ser gerado apenas uma vez e possui validade de 24 horas. Armazene o token no seu sistema e monitore o expires_in.

Erros comuns

401 Unauthorized

Token invalido ou expirado.

1. O parceiro recebe credenciais de ambiente de desenvolvimento
2. Realiza a integracao com os endpoints liberados para o seu escopo
3. Executa os testes de integracao de forma independente
4. Quando estiver pronto, agenda uma validacao com o time do Ze
5. Durante a validacao, sao realizados testes em conjunto

Se aprovado, o time tecnico comunica o comercial e sao liberadas as credenciais de producao.

Esse processo reforca qualidade, seguranca e estabilidade antes do go-live.

Sincrona

• Retorno imediato da operacao
• Status HTTP tipico: 200 OK

Assincrona

• A requisicao e aceita para processamento posterior
• Status HTTP tipico: 202 Accepted

Em fluxos assincronos, acompanhe o processamento via eventos ou polling.

Catalogo padrao do Ze

• Catalogo interno, gerenciado pelo Ze Delivery
• Utilizado na maioria das integracoes

Catalogo externo do parceiro

• O parceiro pode criar e gerenciar o proprio catalogo via API
• Usado em integracoes especificas, mediante validacao

O uso de catalogo externo depende de validacao e alinhamento com o time do Ze.

A API segue o principio de least privilege: voce so acessa os endpoints necessarios, conforme o escopo de integracao alinhado com o time do Ze Delivery.

Sim, mediante alinhamento com os times comercial e tecnico do Ze.

Recomenda-se acompanhamento diario, com alertas para instabilidade ou erros, observando:

• Taxa de erro
• Latencia
• Volume de requisicoes
• Status de pedidos

Atualmente nao disponibilizamos uma status page publica para acompanhamento da disponibilidade da API.

Futuramente sera disponibilizada uma status page para parceiros, com visibilidade sobre disponibilidade, incidentes e historico de indisponibilidades.

• Hoje: via Changelog nesta documentacao
• Futuro: versionamento e alertas automaticos