Integração via API

API do Berga

Ligue o seu sistema, a sua loja ou o seu PDV ao Berga com uma chave de API. A integração usa a mesma API das telas do Berga e faz o que o usuário dono da chave pode fazer.

  • Chave criada por você
  • Validade que você escolhe
  • Revogável na hora
  • JSON por HTTPS
curl \
  -H "x-api-key: SUA_CHAVE" \
  "https://api.berga.app/persons?page=1&pageSize=20"
200A lista de clientes da sua empresa, em JSON, página por página

O que dá para integrar

A chave abre a mesma API que as telas do Berga usam. Alguns exemplos:

Clientes e fornecedores

  • Cadastrar o cliente que entrou pelo seu sistema
  • Consultar a lista de clientes, página por página

Itens e preços

  • Cadastrar itens com preço
  • Achar o item pelo código de barras

Vendas

  • Lançar no Berga a venda feita na sua loja ou no seu PDV
  • Consultar e cancelar vendas

Faturas

  • Consultar faturas, vencimentos e o que já foi pago

Notas fiscais

  • Emitir NF-e e NFS-e
  • Cancelar a NF-e

Cada chamada respeita as permissões do usuário dono da chave e o plano da sua empresa.

Como ligar

  1. Crie a chave no Berga

    Em Integrações › API Keys, clique em Nova Chave. Quem cria precisa da permissão Gerenciar integrações.

  2. Marque Token de automação e escolha a validade

    Dê um nome que diga onde a chave vai ser usada, como "PDV Caixa 01", marque Token de automação e escolha 1 ano, 6 meses, 90 dias ou sem expiração.

  3. Copie a chave

    Ela aparece uma única vez. Guarde num cofre de senhas ou direto na configuração do seu sistema.

  4. Envie a chave em cada chamada

    Toda chamada para https://api.berga.app leva o cabeçalho x-api-key com a chave.

    GET /persons?page=1&pageSize=20
    x-api-key: SUA_CHAVE

Segurança

Você decide o acesso

A chave tem as permissões de quem a criou. Para limitar o que a integração faz, crie a chave com um usuário só para ela, num perfil com o necessário.

Só a sua empresa

A chave enxerga apenas a empresa em que foi criada.

Validade e revogação

Escolha a validade ao criar e revogue quando quiser em Integrações › API Keys: a chave para na hora.

Mostrada uma única vez

A chave aparece só na criação. Perdeu? Revogue e crie outra.

Dúvidas frequentes

A API tem custo à parte?

Não. A chave de API está em todos os planos. O que ela acessa segue o plano da sua empresa e as permissões do usuário dono da chave.

Onde está a documentação das rotas?

Conte pelo contato o que você quer integrar, e enviamos as rotas e um exemplo para o seu caso.

Posso ter mais de uma chave?

Pode. Crie uma por sistema ou por caixa, cada uma com o seu nome, e revogue só a que precisar.

Atendo várias empresas. Uma chave serve para todas?

Não. A chave vale só para a empresa em que foi criada: crie uma chave em cada empresa.

A chave vazou. E agora?

Revogue em Integrações › API Keys: ela para de funcionar na hora. Depois crie outra e troque no seu sistema.

Conte o que você quer ligar ao Berga

Enviamos as rotas e um exemplo para o seu sistema, a sua loja ou o seu PDV.

Falar com a gente