Autenticação e chavesAPI

O aceitaAPI Gateway chavesCHAMPREPAPI com escopo para integrações de servidor e automação. Sessões de conta baseadas em navegador são utilizadas para gerenciar chaves, mas uma integração personalizada deve autenticar suas solicitações de serviço com uma chaveAPI.

Criar uma chave

1. Abrir API Chaves.
2. Escolha um nome que identifique a carga de trabalho e o ambiente.
3. Selecione apenas os escopos de serviço de que a carga de trabalho necessita.
4. Adicione uma lista de endereços IP permitidos quando a carga de trabalho tiver endereços de saída estáveis.
5. Copie a chave uma vez e armazene-a em um gerenciador de segredos ou no keychain.

Não crie uma única chave de escopo amplo para todos os aplicativos. Chaves separadas tornam a rotação, a revisão de auditoria e a resposta a incidentes mais seguras.

Envie a credencial

Authorization: Bearer YOUR_API_KEY

Para exemplos de shell, mantenha o valor em uma variável de ambiente:

curl --fail-with-body \
  --header "Authorization: Bearer $CHAMPREP_TOKEN" \
  https://api.champrep.com/v1/auth/whoami

Não insira uma chave em uma URL, parâmetro de consulta, pacote de JavaScript do front-end, aplicativo móvel, linha de log ou evento de análise.

Catálogo de escopos

Os escopos públicos a seguir estão agrupados por serviço. O painel exibe os escopos atualmente disponíveis para a conta.

Serviço	Leia ou utilize	Gravar ou gerenciar
Identidade	users:read, api:read, cli:use	api:manage
Drive	drive:read	drive:write, drive:delete
Chat	chat:read	chat:write
Calendar	calendar:read	calendar:write
Contacts	contacts:read	contacts:write
Meet	meet:read	meet:write
Notes	notes:read	notes:write
Learn	courses:read	courses:write
CHAMPREP AI	ai:chat	ai:chat
Mail	mail:read	mail:write, mail:send
Work	work:read	work:write, work:delete
Invoice	invoice:read	invoice:write, invoice:send, invoice:delete
Negócios	business:read	business:manage
Faturamento	billing:read	billing:manage
Org Chart	charts:read	charts:write, charts:delete
CHAMPREP QA	qa:read	qa:write
Forms	forms:read	forms:write
Webhooks	—	webhooks:manage

O escopo curinga concede amplo acesso e deve ser reservado para integrações administrativas rigorosamente controladas. Um escopo permite uma categoria de ação; ele não se sobrepõe às permissões de plano, função, organização ou recurso.

Ciclo de vida da chave

Alternar

Crie ou gere uma nova chave de substituição, implante-a, confirme se a carga de trabalho está utilizando-a e, em seguida, revogue a chave anterior. Evite uma rotação que deixe uma carga de trabalho autônoma sem credenciais válidas.

Revogar

Revogue uma chave imediatamente se ela for exposta, copiada para um sistema não confiável ou se não pertencer mais a uma carga de trabalho ativa. Uma chave revogada deve retornar 401 e não deve ser tentada indefinidamente.

Revisão

Revise regularmente os nomes das chaves, escopos, restrições de IP, informações de último uso e atividades de auditoria. Exclua as chaves não utilizadas em vez de mantê-las para um possível script futuro.

Login pelo navegador e CLIlogin

champrep auth login utiliza um fluxo de aprovação no navegador para uma pessoa em um terminal. champrep auth token armazena uma APIchave com escopo para automação. A CLI protegeCLI as credenciais armazenadas com o keychain do sistema operacional e envia todos os comandos de rede por meio do Gateway.

Consulte CLI autenticação e API chaves para CLIautomação para esses fluxos de trabalho.