Fundamentos

Autenticação e chaves

Acesso da pessoa, chave da integração e autorização da conta têm funções distintas.

{ } Referência da API Parâmetros e testes →✧ Para agentes de IA Markdown e OpenAPI →

Entre com a conta do Portal

Google e Microsoft são as opções de acesso. Após autenticar, a página inicial apresenta o consumo das integrações. A sessão do navegador permite gerenciar chaves. A API e o MCP recebem a chave da integração, sem solicitar a senha da pessoa.

Envie X-API-Key

Envie a chave no cabeçalho de cada chamada. Não coloque a chave na URL, em logs, em repositórios ou no código público do navegador. O teste interativo mantém o valor apenas no campo da página e não o inclui nos exemplos copiados.

Exemplo

X-API-Key: <sua-chave>
Accept: application/json

Vínculo e permissões

A chave pertence à pessoa e à conta cedente ou financiadora escolhida. O servidor confere a validade, os escopos e o vínculo atual. Revogação, expiração, conta inativa ou vínculo removido podem impedir uma chamada. A chave não amplia os acessos da pessoa.

Validade e revogação

As opções de validade são 30, 90, 180 ou 365 dias. O limite é de 20 chaves ativas por pessoa. Crie uma nova chave para substituir uma que será descontinuada. Atualize seus consumidores e revogue a chave antiga. O valor completo não pode ser recuperado pela lista.