Skip to main content
A Admin API está em beta. Os endpoints disponíveis e o comportamento podem mudar.
A Admin API oferece aos administradores de conta Enterprise acesso programático baseado em escopos a análises e recursos de administração da conta. A maioria dos endpoints fornece acesso de leitura aos dados da conta, enquanto escopos de escrita permitem operações específicas, como a atualização de orçamentos. Use a API para criar relatórios internos, fluxos de trabalho operacionais e integrações para sua conta Enterprise.

​
Quem pode acessar a Admin API

A Admin API está disponível apenas para administradores de conta em contas Enterprise. Administradores de conta podem criar e gerenciar chaves de API. Administradores de workspace e outros membros da conta não podem acessar a Admin API nem criar suas chaves. Para saber mais sobre as funções de administrador Enterprise, veja Administradores de Conta e de Workspace.

​
Criar uma chave de API

1

Abrir as configurações de Desenvolvedor

Na sua conta Enterprise, abra Settings e selecione Developer.
2

Criar uma chave de API

Selecione Create API key e escolha acesso somente leitura ou de leitura e escrita.
3

Armazene sua chave com segurança

Copie a chave, que começa com rpl_, e armazene-a em um gerenciador de segredos seguro. Trate-a como uma senha e nunca a compartilhe.
4

Autentique sua integração

Envie a chave como um Bearer token nas suas requisições de API.

​
O que você pode fazer

A Admin API usa escopos para controlar o que cada chave pode fazer:
  • Uso: Leia o uso da conta e o custo bruto no livro-razão, filtrado ou agrupado por workspace, membro, projeto ou período.
  • Workspaces: Leia listas e detalhes de workspaces, incluindo contagem de membros e projetos, administradores e data de criação.
  • Membros: Leia a associação à conta e a workspaces, filtrada por função ou pesquisada por nome, nome de usuário ou e-mail.
  • Projetos: Leia projetos em workspaces de equipe, filtrados por visibilidade ou status de implantação, ou pesquisados por título, slug ou descrição.
  • Orçamentos: Leia os orçamentos da conta e use o escopo write:budgets para atualizá-los.
As respostas da API oferecem suporte a paginação por cursor e incluem cabeçalhos de limite de taxa e um X-Request-Id para rastreamento de requisições.

​
Construindo com o Replit Agent

Você pode pedir ao Replit Agent para construir um painel personalizado com a Admin API. Descreva os dados da conta que deseja acompanhar, como uso por workspace ou custos por projeto, e o Agent pode construir o painel e sua integração de API.
1

Abra o seletor de skills

Em um projeto Replit, clique no botão + ao lado da entrada de chat e selecione Use a skill.
2

Selecione a skill Admin API

Em Replit skills, selecione Admin API para dar ao Agent o contexto da API e orientações de integração.
3

Descreva o painel

Diga ao Agent o que você quer acompanhar e como quer visualizá-lo. Por exemplo, peça ao Agent para construir um painel que mostre uso por workspace e custo por projeto.
4

Adicione sua chave de API com segurança

Quando o Agent precisar fazer requisições de API, adicione sua chave da Admin API aos Secrets do seu projeto. Não cole a chave no chat nem a inclua em commits do seu projeto.

​
Referência da API

Para detalhes de endpoints, parâmetros de requisição e exemplos de integração, veja a documentação para desenvolvedores da Admin API.