Ajuda
Glossário
Os termos usados na documentação da API de Integração do VendaSimples, do grupo e da chave de integração ao webhook.
| Termo | Significado |
|---|---|
| API | Jeito de um sistema conversar com outro. Aqui, é o caminho para outro sistema da sua empresa ler dados do VendaSimples sem ninguém digitar nada |
| Endpoint | Cada endereço da API, que faz uma coisa só: listar as empresas, consultar um pedido. Veja Endpoints |
| Header | Informação que vai junto com a chamada, separada dos dados. O token de acesso vai no header Authorization |
| JSON | Formato de texto em que a API recebe e devolve os dados: cada campo tem um nome e um valor |
| Código de resposta | Número que diz como a chamada terminou: 200 deu certo, 400 dados inválidos, 401 não autorizado, 429 muitas chamadas, 500 erro do nosso lado. Veja Erros e limites |
| Grupo | Conjunto de empresas de um cliente VendaSimples. A integração acessa os dados de um grupo, e o limite de requisições é contado por grupo |
| Empresa | Cada empresa do grupo, identificada pelo idEmpresa. Veja GET /v1/empresa |
| Administrador do grupo | Usuário administrador do sistema VendaSimples. É quem cria as integrações e cadastra os webhooks |
| Integração | Cadastro feito pelo administrador no sistema, que libera o acesso à API. Define quais empresas do grupo a integração acessa; sem nenhuma empresa escolhida, ela acessa todas as que têm contrato ativo. Em qualquer caso, só entram as empresas com a API de Integração no contrato |
| Chave de integração | Código gerado ao criar a integração, exibido uma única vez. É trocado por um token de acesso. Veja Autenticação |
| Token de acesso | Código enviado no header Authorization de todas as chamadas, sem o prefixo Bearer. Vale por 24 horas e guarda as empresas liberadas no momento em que foi gerado |
| Revogação | Encerramento definitivo de uma integração, feito pelo administrador. A chave deixa de gerar tokens; os tokens já gerados valem até expirar. Veja Revogar a chave |
| Pedido em aberto (orçamento) | Pedido que ainda não foi faturado nem cancelado. Veja GET /v1/pedido/{id}/aberto |
| Parceiro | No VendaSimples, o cadastro de clientes, fornecedores e transportadoras. No pedido, é o cliente, e os dados dele vêm em dadosParceiro |
| Webhook | Aviso que enviamos para uma URL do seu sistema quando um evento acontece. É do grupo, não da integração. Veja Webhooks |
| Evento | Algo que acontece no sistema e gera um aviso de webhook, como o OrcamentoCriado |
| Header adicional | Header com nome e valor definidos no cadastro do webhook, enviado em todos os avisos para o seu sistema confirmar a origem. Veja Validar a origem do aviso |
| Limite de requisições | Quantidade de chamadas que o grupo pode fazer, somando todas as integrações: até 100 de uma vez, com 5 fichas repostas a cada 3 segundos. Veja Limite de requisições |
| sessionGuid | Código que vem nas respostas de erro da API e identifica a chamada. Informe-o ao suporte |