Pular para o conteúdo
Documentation

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.

  1. Abrir API Chaves.
  2. Escolha um nome que identifique a carga de trabalho e o ambiente.
  3. Para cada serviço, escolha um nível de acesso e, em seguida, restrinja-o apenas aos escopos 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.

Authorization: Bearer YOUR_API_KEY

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

Terminal window
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.

A tela API“Chaves” agrupa os serviços em quatro áreas: Espaço de Trabalho, Comunicação, Desenvolvedor e Admin. Para cada serviço, escolha um nível de acesso e, em seguida, adicione ou remova escopos individuais caso a carga de trabalho exija algo mais restrito:

  • Nenhuma: a chave não pode utilizar o serviço.
  • Leitura: os escopos na coluna “Leitura”.
  • Leitura e gravação: Leitura mais os escopos da coluna “Gravação”.
  • Admin: tudo o que foi mencionado acima, além dos escopos na coluna “Admin”, para os serviços que possuem um.

Escopos marcados inscrição opcional nunca são selecionadas por nível. Marque-as pelo nome. Um serviço que não está incluído no seu plano é exibido como bloqueado, com um link para atualizar. A tela sempre exibe o catálogo que está ativo no momento.

ServiçoLeituraGravaçãoAdmin
Drivedrive:readdrive:write, drive:delete—
Documentosdocs:read, docs:exportdocs:write, docs:share, docs:delete—
Planilhassheets:read, sheets:exportsheets:write, sheets:share, sheets:delete—
Notesnotes:readnotes:write—
Calendarcalendar:readcalendar:write—
Contactscontacts:readcontacts:write—
Workwork:readwork:write, work:delete—
Formsforms:readforms:write—
Invoiceinvoice:readinvoice:write, invoice:send, invoice:delete—
Organogramascharts:readcharts:write, charts:delete—
Learncourses:readcourses:write—
Escola LMSAinda não disponível por APIchave

ServiçoLeituraGravaçãoAdmin
Mailmail:readmail:write, mail:send—
Chatchat:readchat:write—
Meetmeet:readmeet:write—
RTCEm breve. A RTC utiliza suas próprias chavesAPI de projeto

ServiçoLeituraGravaçãoAdmin
CHAMPREP Codecode:read_api, code:read_repository, code:read_registry, code:read_package_registrycode:write_repository, code:write_registry, code:write_package_registrycode:api; adesão opcional code:admin_mode
CHAMPREP QAqa:readqa:write—
Fazenda de Executoresrunner_farm:readrunner_farm:write—
CLI—cli:use—
CHAMPREP AI—ai:chat; adesão opcional ai:actions, ai:agent—
ServiçoLeituraGravaçãoAdmin
Negóciosbusiness:read—business:manage
Faturamentobilling:read—billing:manage
Desenvolvedor APIapi:read—api:manage, webhooks:manage
Perfilusers:read——

A administração da plataforma nunca está disponível para uma chaveAPI; é necessário um administrador conectado.

  • CHAMPREP Código. Cada code: O escopo corresponde ao escopo do token de acesso pessoal de mesmo nome no CHAMPREPCode, e o Code verifica isso em cada endpoint. code:api representam acesso total de leitura e gravação a tudo o que sua conta pode acessar no Code, portanto, estão no nível de Administrador; prefira as opções mais restritas read_ e write_ . Os endpoints de administração do Code precisam de uma chave que contenha code:admin_mode por nome e uma conta que seja administradora do Code.
  • Fazenda de Runners. runner_farm:write registram e gerenciam executores, pools e conexões. Ele nunca adquire créditos nem altera configurações de pagamento, e nunca emite, substitui ou testa um segredo de conector ou token de executor. Essas ações exigem que uma pessoa esteja conectada.
  • Docs e Sheets. Compartilhamento (colaboradores, compartilhamento de links, publicação), exclusão permanente ou limpeza e exportação requerem, cada um, seu próprio escopo. Uma chave com apenas docs:write ou sheets:write podem editar o conteúdo, mas não podem compartilhá-lo, eliminá-lo ou exportá-lo.
  • CHAMPREP AI. ai:agent permitem que o CLI Agente de IA utilizam ferramentas locais e incluem ai:chat. ai:actions aprovam ou rejeitam as ações que a IA propõe em seus serviçosCHAMPREP, e nada mais.

O escopo curinga * (acesso total) abrangem todos os serviços incluídos em seu plano, incluindo CHAMPREPCode, Runner Farm e Docs. O CHAMPREPCode trata isso como code:api, o que significa acesso total de leitura e gravação. Isso não inclui ai:agent ou code:admin_mode; estes devem sempre ser selecionados pelo nome.

Reserve o curinga para integrações administrativas rigidamente controladas e restrinja as chaves de acesso total existentes caso elas não necessitem dos serviços mais recentes. 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.

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.

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.

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.

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.