Documentação

Português

Français
Deutsch
Italiano
English
Español
Shqip

Português

Français
Deutsch
Italiano
English
Español
Shqip

Aparência

A API e as chaves API ​

Um assistente como o Claude ou o ChatGPT liga-se através da página de autorização do To Bill: consulte Ligar um assistente de IA. Uma ferramenta que não tem essa página, um script, um cliente MCP de linha de comandos ou uma automatização, utiliza uma chave API pessoal. Esta página explica as chaves e indica os endereços técnicos.

Os endereços ​

O quêEndereço
Servidor MCP (assistentes de IA)https://app.tobill.ch/mcp
API do To Billhttps://app.tobill.ch/api/…
Descoberta OAuthhttps://app.tobill.ch/.well-known/oauth-authorization-server
Referência da API (beta)https://docs.tobill.ch/api

O servidor MCP dá ao assistente ferramentas prontas a usar para a contabilidade e a faturação, além de duas ferramentas que abrem todo o resto do To Bill: uma procura a rota certa da API, a outra chama-a, com os mesmos controlos que a aplicação.

A referência da API descreve cada rota que uma chave abre, com os parâmetros, as respostas e exemplos; a versão interativa permite experimentar um pedido com a sua chave.

Criar uma chave ​

  1. Abra Definições › Ligações IA e API.
  2. Em Chaves API pessoais, clique em Criar uma chave.
  3. Dê-lhe um Nome que diga para que serve, escolha o Acesso (Só leitura ou Leitura e alteração) e a Validade (30, 90 ou 365 dias), e clique em Criar a chave.
  4. Copie a chave: só é mostrada uma vez. Depois clique em Copiei a chave.

A chave começa por tb_pk_. Abre a empresa onde estava ao criá-la, com as suas permissões nessa empresa. A lista mostra depois o seu início, o seu acesso, a sua empresa, a data de expiração e a última utilização, nunca a chave inteira.

Uma chave é uma palavra-passe

Quem tiver a chave age no To Bill em seu nome. Não a coloque num e-mail, num documento partilhado nem num repositório de código. Uma chave perdida revoga-se de imediato (ver abaixo) e substitui-se por uma nova.

Enviar a chave ​

Cada pedido leva a chave no cabeçalho HTTP Authorization, como token Bearer:

bash
curl https://app.tobill.ch/api/clients -H "Authorization: Bearer tb_pk_…"

Claude Code com uma chave ​

bash
claude mcp add --transport http tobill https://app.tobill.ch/mcp --header "Authorization: Bearer tb_pk_…"

O que uma chave abre e o que não abre ​

  • Com Só leitura, a chave apenas lê: qualquer alteração é recusada.
  • Com Leitura e alteração, faz o que o utilizador pode fazer na empresa, com os mesmos controlos que a aplicação, e nunca mais do que as permissões do seu perfil.
  • Não abre o início de sessão na sua conta, a subscrição, os pagamentos, a gestão das ligações e das chaves, outra empresa nem o cockpit de um fiduciário.
  • Cada alteração feita com a chave fica registada na atividade da empresa com o nome que lhe deu.
  • O To Bill limita o número de pedidos por minuto e por chave; acima desse limite, recusa os pedidos durante algum tempo e a ferramenta tem de esperar antes de tentar novamente.

Revogar uma chave ​

Em Definições › Ligações IA e API, clique em Revogar ao lado da chave e confirme. Deixa de funcionar, de imediato. Uma chave que expirou fica na lista, marcada Expirada, até a revogar.