API Vendizap

Introdução

A API do Vendizap, permite uma integração com qualquer plataforma que consiga fazer requisições HTTP. Nela é possível realizar os cadastros que possuem dentro da plataforma, além de atualização de estoque e recebimento de pedidos através de webhook.

Autenticação

Para o Vendizap identificar qual é o usuário que está se comunicando com a API, é necessário que este usuário configure e ative uma integração no submenu Integrações do menu Configurar do Vendizap. Nesta tela será fornecido um Id e um Secret que será utilizado em todas as requisições como forma de identificação e autenticação do usuário respectivamente. Esses dados deverão ser enviados no Header como no exemplo abaixo:

Header

Plain Text

X-Auth-Id: 4754521
X-Auth-Secret: ChpATl7F?Wi5jmfZnQy1LgJXeq0a8V%@

"Lembrando que os dados acima não são válidos, são apenas um exemplo.”

Retornos

O retorno dos métodos será sempre no formato JSON em caso de sucesso e com o respectivo HTTP Status Code, que poderá ser um dos seguintes:

HTTP Code	Nome	Descrição
200	Success	Sucesso na requisição solicitada acompanhado do respectivo retorno
201	Created	Sucesso ao inserir um novo registro através dos métodos POST acompanhado do respectivo ID e possíveis erros
400	Bad Request	Erro na requisição que não foi possível ser completada, acompanhada do respectivo erro (nesses casos o erro será retornado em uma string e não em JSON)
401	Unauthorized	Credenciais informadas inválidas

Limites de requisição

Cada IP será avaliado de forma individual e caso envie muitas requisições para o servidor, esse IP pode ser temporáriamente bloqueado.

Limites por assinatura do cliente:

Na Vendizap existem dois planos que dão acesso à API, porém os limites de requisições em cada plano é diferente:
Plano Profissional: 150 requisições a cada hora;
Plano Empresarial: Não há limite por hora, mas não impede que o IP seja temporáriamente bloqueado, caso envie muitas requisições seguidas.

Exemplos

GET

Nestes casos serão retornados os campos referentes ao item solicitado, podendo ser um array com a lista dos objetos ou apenas um único objeto JSON caso tenha sido solicitado via ID.

POST, PUT e PATCH

Na maioria dos casos de métodos POST, PUT e PATCH o retorno será o id do registro. Em casos de erros parciais, ou seja, que não impossibilitou o restante da execução do método, os mesmos serão retornados em um campo array com o nome erros, conforme exemplo abaixo:

Plain Text

{
       "id": "6026ef37b6fa7c6ac6574a82",
       "erros": ["Erro ao inserir imagem da posição 1: Formato da imagem inválido."]
}