Aller au contenu principal

Visão geral da API

A API do Validades permite que os sistemas da sua organização leiam e alterem os dados do Validades: produtos, lotes, categorias, marcas e lojas. Com ela, você pode, por exemplo:

  • cadastrar produtos e lotes automaticamente a partir do seu ERP ou sistema de estoque;
  • buscar os lotes que vencem nos próximos dias para montar relatórios ou alertas próprios;
  • manter outro sistema sincronizado com o Validades, recebendo só o que mudou.

Tudo o que é feito pela API aparece no aplicativo e no site, sincronizado com todos os aparelhos da organização, como se tivesse sido cadastrado por um membro.

Quem pode usar​

A API está disponível para organizações com assinatura ativa. Contas e espaços pessoais não têm acesso.

O acesso é liberado manualmente pela nossa equipe:

  1. O dono ou um administrador da organização pede acesso em validades.com → Time → API, aceitando os Termos de Uso da API.
  2. Nossa equipe analisa o pedido, e você recebe um e-mail quando ele for aprovado.
  3. Com a API liberada, o dono ou um administrador cria as chaves de API no mesmo painel.

O passo a passo completo está em Primeiros passos.

Endereço e versão​

URL basehttps://api.validades.com
Versão atualv1 (todas as rotas começam com /v1)
Especificação OpenAPIhttps://api.validades.com/v1/openapi.json
Formato das respostasJSON (padrão) ou XML
Formato do corpo das requisiçõesJSON

A especificação OpenAPI 3.1 descreve todas as rotas, parâmetros e respostas. Você pode importá-la no Postman, no Insomnia, no Bruno ou em geradores de código.

Recursos​

RecursoLerCriarAlterarExcluirPágina
Produtos✓✓✓✓Produtos
Lotes✓✓✓✓Lotes
Categorias e marcas✓✓✓✓Categorias e marcas
Lojas✓✓✓✓Lojas
Exclusões✓Exclusões
Sua chave✓Conta (/v1/me)

Como a API funciona, em resumo​

  • Autenticação: cada requisição leva a chave no cabeçalho Authorization: Bearer vld_live_.... Veja Autenticação.
  • Limites: 60 requisições por minuto por chave, 120 por organização e 50.000 por mês. Veja Limites e cota.
  • Listas paginadas por cursor, com filtro updated_since para buscar só o que mudou. Veja Paginação e sincronização.
  • Erros sempre no mesmo formato, com um código estável. Veja Erros.
  • Requisições seguras de repetir com Idempotency-Key, e proteção contra sobrescrever alterações com If-Match. Veja Concorrência e idempotência.
Use a chave só no seu servidor

A chave dá acesso aos dados da sua organização. Nunca a coloque em aplicativos, sites, extensões de navegador ou qualquer código que rode no aparelho de outras pessoas. Por isso a API não aceita chamadas feitas direto do navegador (não há CORS).