Apresentando as Admin APIs

Última atualização: 26 de agosto de 20263 min de leitura

Apresentando as Alchemy Admin APIs para gerenciamento e uso de apps

O dashboard funciona bem para gerenciar um único app. Mas equipes que rodam Alchemy em escala, com um app dedicado por cliente, por parceiro ou por ambiente, acabam com tarefas repetitivas. Elas ficam clicando pelo mesmo fluxo de criação, atualização de allowlist e verificação de uso.

É por isso que estamos abrindo duas Admin APIs para tornar isso mais fácil e mais fluido para quem constrói:

Apps Management API: cria, configura e exclui apps, gerencia allowlists.
Usage API: obtém os mesmos números de uso da aba Usage do dashboard.

Ambas as APIs são acessíveis a partir de um único endpoint com uma única Access Key. Pegue uma Access Key em Settings → Security no dashboard, com escopo para App Management ou Usage, e aponte-a para https://admin-api.alchemy.com/v1.

Apps Management API

A Apps Management API cuida do CRUD que você faria manualmente no dashboard: criar um app, definir sua network allowlist e gerenciar suas allowlists de endereço, domínio e IP.

bashCopied
curl -X POST 'https://admin-api.alchemy.com/v1/apps' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your access key}' \
--data '{
  "name": "app-tenant-42",
  "networkAllowlist": ["ETH_MAINNET"],
  "products": ["node-api"]
}'

Isso substitui o trabalho manual de uma plataforma que provisiona um app dedicado por cliente, de uma equipe que dá a cada parceiro ou node operator seu próprio app para isolar o uso, ou de um pipeline que cria um app novo por ambiente. As Access Keys têm seus próprios escopos, expiração e rotação, então o provisionamento de apps pode ficar no CI/CD junto com todo o resto, em vez de ser uma etapa exclusiva do dashboard.

Usage API

A Usage API é um endpoint somente leitura para os números que você normalmente obteria na aba Usage do dashboard: total de CUs geral e por network, e do mês corrente, além de, nos planos pagos, detalhamentos por app, método e network em tráfego HTTP, WebSocket e webhook, uso em dólares e contagem de requests.

bash

Copied

curl 'https://admin-api.alchemy.com/v1/usage/summary' \
--header 'Authorization: Bearer {your access key}'

O histórico e o nível de detalhe escalam de acordo com o plano:

Plan	What's included
Free	High-level CU summary, 1 day of history
PAYG	Full breakdown, 7 days of history
Enterprise	Full breakdown, 30 days of history

Autentique com qualquer uma das credenciais como bearer token: uma Access Key com escopo de Usage somente leitura para números de toda a equipe, ou uma API key existente com escopo de app, enviada da mesma forma, se você precisar apenas dos números de um app.

Como começar

Crie uma Access Key na aba Security, defina o escopo do que você precisa e chame https://admin-api.alchemy.com/v1.

Explore a documentação e fale com nossa equipe para tirar dúvidas ou discutir soluções especializadas em escala.

FAQ

Qual é a diferença entre Apps Management e Usage?

Apps Management cria e configura apps: nomes, network allowlists e allowlists de endereço, domínio e IP. Usage é somente leitura. Retorna totais de compute units e, nos planos pagos, detalhamentos em série temporal. Defina o escopo da Access Key apenas para a permissão necessária.

Como eu me autentico na Admin API?

Crie uma Access Key na aba Security do dashboard, habilite App Management e/ou Usage, e envie-a como Authorization: Bearer {your access key} para https://admin-api.alchemy.com/v1.

Quanto histórico de uso eu tenho?

O intervalo da série temporal é de 1 dia no Free, 7 dias no PAYG e 30 dias no Enterprise. O Free traz um resumo de CU de alto nível; PAYG e Enterprise têm o detalhamento completo.

Newsletter da Alchemy

Seja o primeiro a saber sobre lançamentos

Assine nossa newsletter

Receba as últimas atualizações de produtos e recursos da Alchemy

Mais de 80.000 inscritos

Ao inserir seu endereço de e-mail, você concorda em receber nossas comunicações de marketing e atualizações de produtos. Você reconhece que a Alchemy processa as informações que recebemos de acordo com nosso Aviso de Privacidade. Você pode cancelar a inscrição a qualquer momento.