VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Guia rápido

Primeiros passos

O caminho de zero até a primeira chamada à API da Venddor: endereço da loja, credenciais, convenções, erros e limites.

Esta seção reúne o que vale para todas as operações do guia rápido: onde fica a loja na internet, como provar quem você é, como são os formatos de resposta e de erro e quais limites existem. Leia uma vez; depois você só volta aqui para consultar.

Pontos-chave
  • Toda chamada vai para uma loja (tenant). O endereço da loja já a identifica; em ambientes de teste você pode escolher a loja com o cabeçalho X-Tenant-ID.
  • A API autentica com JWT obtido em POST /api/v1/auth/login e renovado em POST /api/v1/auth/refresh.
  • Os corpos são sempre JSON em UTF-8. Dinheiro é inteiro em centavos; datas seguem o padrão RFC 3339.
  • Os erros chegam como {"error": "mensagem"}, com o código HTTP decidindo o que fazer; a página Erros mostra todos os formatos.
  • Aplicativos de terceiros que não devem receber a senha de um usuário usam um token de app com escopos.

O que você vai encontrar aqui

PáginaPara que serve
Endereço e ambientesComo montar a URL base, como a plataforma descobre qual é a loja e o que são os ambientes.
AutenticaçãoLogin com JWT, renovação, token de app e chave da vitrine.
Sua primeira requisiçãoTutorial ponta a ponta: autenticar, listar produtos, criar cliente e criar pedido.
ConvençõesJSON, cabeçalhos, paginação, filtros, ordenação, datas, dinheiro e ids.
ErrosO formato de erro e o significado de cada código HTTP.
Limites e boas práticasLimite de requisições, repetição segura, idempotência e webhooks.
GlossárioLoja, tenant, seller, sub-pedido, SKU, status em letra e demais termos.
Perguntas frequentesAs dúvidas que mais aparecem na primeira integração.

O caminho mais curto

  1. Descubra o endereço da loja

    Peça ao responsável pela loja o endereço dela (por exemplo https://minhaloja.io.venddor.com.br). É a sua $BASE_URL. Detalhes em Endereço e ambientes.

  2. Obtenha a credencial

    Use um usuário administrador da loja e faça login para receber um JWT. Veja Autenticação.

  3. Faça a primeira chamada

    Siga Sua primeira requisição e depois vá para a área de que precisa.

Próximos passos

Autenticação
Obtenha a sua credencial.
Sua primeira requisição
Do login ao primeiro pedido.
Pedidos
A área mais usada das integrações.
Anterior
Guia rápido
Próxima
Endereço e ambientes
Nesta página
  • O que você vai encontrar aqui
  • O caminho mais curto
  • Próximos passos