Referência de API

A Vnda disponibiliza endpoints para que lojistas, agências e parceiros integradores possam integrar sistemas externos com nossa plataforma. Nessa seção você consulta as rotas e operações disponíveis da nossa API, e confere também como utilizar os endpoints em cada contexto da loja virtual.

Organização da Referência de API

A Referência de API está organizada da seguinte forma:

  • Pela lateral esquerda você navega entre endpoints disponíveis. Eles estão divididos pelo seu contexto de aplicação e operação (GET, POST, PUT, DELETE, PATCH);
  • Na lateral direita você encontra os campos de preenchimento de autorização e servidor; e seleciona também qual linguagem deseja utilizar.
  • No centro da página você confere a descrição dos parâmetros de entrada e de saída de cada rota, e os campos de preenchimento do body request.
Organização da referência de API

Organização da referência de API

Endpoints e requests:

As rotas estão disponíveis para os ambientes de teste e de produção, e você pode realizar suas requisições diretamente da referência do endpoint. Para saber como fazer um request por aqui, confira em Como realizar requisições pela Referência de API.

Para saber como obter seu token, filtrar e fazer uma requisição utilizando o Postman, veja nossa seção Guia de API.