Guias da API Zaub V2
Guias rápidos para integrar com a API pública da Zaub. A referência completa de cada endpoint está em Referência.
Autenticação
Os integradores externos autenticam com um token de integração enviado no
header Authorization, no formato Bearer zkb_live_<seu_token>.
O token é emitido pelo administrador da sua conta (seção de chaves/tokens de integração).
curl -H "Authorization: Bearer zkb_live_SEU_TOKEN" \
https://api.bendito.digital/api/v2/Product/List?Page=0&Size=50
zkb_live_ são roteados automaticamente para a autenticação
de integração. Usuários internos do sistema usam JWT (login) — não aplicável a integradores.
Ambientes
| Ambiente | URL base | Uso |
|---|---|---|
| Produção | https://api.bendito.digital/ | Integrações reais |
| Staging | https://api-staging.bendito.digital/ | Testes/homologação |
Todos os endpoints da V2 ficam sob o caminho /api/v2/ — por exemplo:
https://api.bendito.digital/api/v2/Client/List.
Paginação
Os endpoints de listagem aceitam os parâmetros de query Page e Size:
| Parâmetro | Descrição | Padrão |
|---|---|---|
Page | Número da página (base 0) | 0 |
Size | Quantidade de itens por página | 50 |
GET /api/v2/Product/List?Page=0&Size=50
A resposta traz a página de itens junto com o total de resultados e o total de páginas,
permitindo navegar pelas páginas seguintes incrementando Page.
Filtros
Cada endpoint de listagem aceita filtros próprios via query string, combináveis com a
paginação. Os filtros disponíveis para cada rota estão documentados na
Referência (parâmetros de query da operação). Exemplos comuns:
Description (busca textual), datas (StartDate/EndDate)
e enums de tipo/situação.
GET /api/v2/Market/List?Description=Feira&StartDate=2026-01-01T00:00:00Z&Page=0&Size=20
Formato das respostas
As respostas seguem um envelope padrão com indicador de sucesso, código HTTP, os dados
(data) e, em caso de erro, a lista de mensagens. Os códigos usuais são
200 (sucesso), 400 (validação), 401 (não autenticado)
e 404 (não encontrado). Os exemplos de cada resposta estão na
Referência de cada endpoint.