Pular para o conteúdo principal
Neste guia você cria uma chave, faz a primeira chamada e lê a resposta. Você precisa de acesso de administrador à conta Zouti e de um terminal com curl (ou Node.js 18+, Python 3 ou PHP).
1

Crie uma chave de API

No dashboard da Zouti, abra Configurações → Chaves de API e clique em Criar chave. Só um administrador da conta cria chaves.
  • Nome da chave: diga onde ela vai ser usada, como ERP ou Planilha financeira.
  • Expiração (opcional): no mínimo 1 hora a partir de agora. Sem data, a chave não expira.
A chave (zt_live_...) aparece uma única vez, no painel Chave de API criada. Copie e guarde num cofre de segredos: a Zouti guarda só um hash e não consegue mostrá-la de novo.
2

Guarde a chave numa variável de ambiente

Troque zt_live_... pela chave copiada. Todos os exemplos desta documentação leem a chave de ZOUTI_API_KEY. Não escreva a chave no código.
3

Faça a primeira chamada

Peça o pedido mais recente da conta:
A mesma chamada em Node.js, Python e PHP está ao lado. Uma chave recém-criada leva cerca de 1 segundo para valer: se a primeira chamada receber 401, espere alguns segundos e repita.
4

Leia a resposta

A resposta é uma página de pedidos:
  • object é "list".
  • data traz os pedidos, do mais novo para o mais antigo. data[0] é um objeto pedido.
  • has_more diz se há mais páginas. Quando é true, envie next_cursor no parâmetro cursor para ler a próxima. Veja Paginação.
Os headers também importam:
  • Request-Id identifica a requisição (req_...). Guarde-o no log e informe-o ao suporte.
  • RateLimit-Limit, RateLimit-Remaining e RateLimit-Reset mostram quanto do limite da conta ainda está disponível. Veja Limites de requisição.
Se a conta ainda não tem pedidos, data vem vazio e has_more vem false.

Se algo der errado

Os demais códigos estão em Erros.

Próximos passos

Autenticação

Guardar a chave, trocá-la sem parar a integração e revogá-la.

Sincronização de pedidos

Manter uma cópia local dos pedidos novos e alterados.

Objeto pedido

Todos os campos do pedido e o significado de cada valor.

Erros

O que fazer com cada code e quando repetir.