Ajuda vhsys

Integração via API

Publicado em Revisado em

Requisitos de acesso

Planos elegíveis

  • MEI
  • Essencial
  • Controle
  • Completo
  • Gestão Integrada

A Integração via API vhsys é a solução ideal para quem quer conectar diferentes sistemas e fazer seus aplicativos trabalharem em perfeita harmonia.
Com essa tecnologia, você pode integrar o vhsys com diversos outros sistemas, mesmo que tenham sido criados em plataformas diferentes. Isso significa que seus dados estarão sempre sincronizados na nuvem, prontos para serem acessados, alterados ou excluídos a qualquer momento, com total segurança e praticidade.

Benefícios da integração via API:

  • Conecte o vhsys a aplicativos e sistemas externos com poucos cliques;
  • Tenha todos os seus dados centralizados e atualizados automaticamente;
  • Elimine tarefas manuais e ganhe tempo para focar no crescimento do seu negócio;
  • Conte com uma integração estável, rápida e segura.

Como contratar a Integração API

Antes de começar, é necessário realizar a instalação da Integração API. Para isso:

  1. Acesse a “Loja de Integração”.
  2. No campo de pesquisa, busque por “API”.
  3. Clique no botão “Assinar”.
  4. Escolha o plano desejado.
  5. Confirmar dados da conta e forma de pagamento.

GIF do passo a passo para contratar a Integração via API na Loja de Integração.

Copiar as chaves da integração API

Após realizar a contratação, você clique em “Abrir aplicativo”.

GIF mostrando como copiar as chaves de acesso da Integração API.

Como utilizar

Clique aqui e você encontrará todos os endpoints necessários para integrar seu sistema com a vhsys, permitindo que você, por exemplo:

  • Cadastre e gerencie seus produtos
  • Adicione e consulte clientes
  • Lance e acompanhe suas vendas

Veja o passo a passo no Postman:

GIF do passo a passo de uma requisição no Postman usando a API.

Importante

Remova as chaves {} e substitua pelo número do ID real do cliente, por exemplo.

Print mostrando a substituição das chaves {} pelo ID real do cliente na requisição.

Dados técnicos da API (URL base e autenticação)

A API vhsys é REST, troca dados em JSON e todas as chamadas usam a URL base:

https://api.vhsys.com/v2

Toda requisição precisa enviar as chaves geradas no aplicativo Integração via API nos cabeçalhos (headers):

HeaderObrigatórioO que enviar
access-tokenSimChave pública copiada no aplicativo
secret-access-tokenSimChave secreta copiada no aplicativo
Content-TypeSim (POST/PUT)application/json
partner-tokenNãoToken do parceiro, quando houver
User-AgentRecomendadoNome e versão da sua aplicação (ajuda no diagnóstico)

Exemplo de consulta de clientes:

GET https://api.vhsys.com/v2/clientes?limit=50&offset=0
access-token: SUA_CHAVE
secret-access-token: SUA_CHAVE_SECRETA

Consulte a referência completa em developers.vhsys.com.br/api.

Parâmetros de consulta e paginação

Nos endpoints de listagem (método GET) você pode combinar os parâmetros abaixo na URL:

  • limit — quantidade de registros por página (máximo de 250);
  • offset — registro inicial da consulta, usado para paginar;
  • order — campo usado na ordenação (ex.: data_mod_cliente);
  • sort — Asc ou Desc;
  • lixeira=Sim — retorna os registros que foram excluídos;
  • filtros específicos de cada recurso (ex.: cnpj_cliente, razao_cliente, tipo_pessoa).

Para sincronizações periódicas, o caminho mais eficiente é ordenar pela data de modificação e buscar somente o que mudou desde a última execução.

Endpoints disponíveis por módulo

Os links abrem a documentação oficial em uma nova aba:

Cada recurso segue o mesmo padrão: POST para cadastrar, PUT para atualizar, GET para consultar ou listar e DELETE para excluir.

Boas práticas e erros mais comuns

  • 401 / não autorizado — chaves ausentes, trocadas entre si ou copiadas com espaços. Confira access-token e secret-access-token;
  • 403 — aplicativo Integração via API não está ativo na conta ou o plano foi cancelado;
  • 404 — ID inexistente ou as chaves {} não foram substituídas pelo ID real na URL;
  • 422 / campos inválidos — campo obrigatório faltando ou formato incorreto (datas, CNPJ, valores decimais);
  • 429 — muitas chamadas em sequência. Faça pausas, use paginação e evite consultas repetidas;
  • Nunca exponha as chaves em código de front-end, repositórios públicos ou prints;
  • Registre as respostas de erro da API: elas trazem a mensagem exata do que precisa ser corrigido.

Se você ainda tiver alguma dúvida, pode falar com o nosso time de suporte pelo chat ou pelos outros canais de atendimento. Estamos aqui para te ajudar!

Muito sucesso para o seu negócio e até breve. 😃

Assuntos relacionados

vhsys — Empresa desorganizada não perde só tempo, perde dinheiro todos os dias. Comece seu teste grátis.

Este artigo foi útil?

Escolha uma opção para avaliar.

Perguntas Frequentes

Como faço para contratar a integração via API no vhsys?

Para contratar, acesse a "Loja de Integração" no seu sistema vhsys. Utilize o campo de pesquisa para buscar por "API" e, ao encontrar, clique no botão "Assinar". Em seguida, escolha o plano que melhor atende sua necessidade, confirme os dados da conta e a forma de pagamento para concluir a instalação.

Onde encontro as chaves da API depois de assinar o serviço?

Após realizar a contratação da integração na Loja de Integração, você deve clicar no botão "Abrir aplicativo". As chaves necessárias para a integração serão exibidas nessa tela. Copie essas chaves para configurar a conexão entre o vhsys e seus outros sistemas de forma segura.

O que eu posso fazer utilizando a API do vhsys?

Com a API, você pode conectar o vhsys a outros aplicativos para sincronizar dados e automatizar tarefas. É possível, por exemplo, cadastrar e gerenciar produtos, adicionar e consultar clientes, e também lançar e acompanhar suas vendas. Isso centraliza suas informações e elimina trabalhos manuais.

Teste grátis