API de Gestão

Tudo o que o painel faz com a sua empresa, por código: convidar e remover pessoas, criar contas e girar chaves, acompanhar o consumo e recarregar o saldo antes que ele acabe.

Perguntas frequentes

A API de gestão é cobrada?

Não. Ela administra a sua empresa na getByte — equipe, contas, saldo e faturas — e as chamadas são gratuitas. O que é cobrado continua sendo o uso das APIs de consulta de cada conta.

Qual é a diferença entre o token de gestão e a chave da conta?

A chave da conta (sk-…) consulta um serviço, como placa ou CPF, e é cobrada por requisição. O token de gestão (gbp_…) é pessoal: ele age em nome de quem o gerou, administra a empresa e, com a permissão de consultas, roda consultas pela rota /consultas usando a conta da empresa — sem nunca ver a chave dela. Um não funciona no lugar do outro.

Um token pode fazer mais do que a pessoa que o gerou?

Não. A permissão efetiva é o que o token pediu somado ao limite do papel da pessoa na equipe naquele momento. Se o papel dela for rebaixado, o token encolhe na hora; se o papel novo não puder ter token, ou se ela sair da equipe, o token para de funcionar.

Posso recarregar o saldo automaticamente?

Sim. O seu sistema consulta o saldo e dispara a recarga quando ele passa de um limite: por Pix, que gera um QR para pagar, ou no cartão cadastrado, que credita na hora. A recarga no cartão pela API tem teto por chamada e por dia, para que um token vazado não esvazie o seu cartão.

Dá para limitar um desenvolvedor a algumas contas?

Sim. Os papéis Desenvolvedor e Leitura, e os papéis personalizados, podem ter escopo por conta: a pessoa, e os tokens dela, só enxergam as contas liberadas. Conta criada por ela entra no escopo automaticamente.

Posso criar um papel com as permissões que eu escolher?

Sim. Além dos cinco papéis padrão — Proprietário, Administrador, Financeiro, Desenvolvedor e Leitura —, a empresa cria papéis personalizados marcando permissão por permissão, pelo painel ou pela API. Mudar as permissões de um papel vale na hora para todos que o têm. Só encerrar o cadastro fica fora: é exclusivo do Proprietário.

Fica registrado quem fez o quê?

Sim. Convites, mudanças de papel, tokens, leitura e troca de chave, criação de conta e recarga ficam na atividade da equipe, com quem fez, quando e se foi pelo painel ou pela API.