Pular para o conteúdo

Chaves de API

As chaves de API autorizam o acesso à API e devem ser incluídas em cada solicitação. Existem dois tipos:

  • Chaves de API Paga (começando com key_...)
  • Chaves de API Gratuita (começando com ckey_..., onde c representa criptográfico)

Criando uma Nova Chave de API

Para obter uma chave de API paga, siga estas etapas:

  1. Registre-se em uma conta no aplicativo ALTCHA em eu.altcha.org para clientes da UE, ou us.altcha.org para clientes dos EUA.

  2. Após o registro, crie um novo projeto.

  3. Abra o projeto recém-criado e acesse as configurações do projeto:

  4. Clique em “Criar Chave de API”, defina um nome e clique em “Salvar”.

Configurando as Chaves de API

Ao criar uma nova chave de API, você verá várias opções de configuração:

  • Nome: Um nome personalizado para ajudar a identificar a chave.
  • Segredo: Uma chave secreta para verificação criptográfica, gerada aleatoriamente por padrão.
  • Limite de Taxa: Um limite de taxa opcional aplicado a todas as solicitações autenticadas com essa chave.
  • Domínios de Referência: Uma lista opcional de nomes de domínio permitidos. Insira um domínio por linha. Para portas não padrão, formate como <domínio>:8080.
  • Recursos: Ative recursos específicos para essa chave de API.

Limites de Taxa

Você pode configurar limites de taxa personalizados para cada chave de API, expressos como solicitações por intervalo (<solicitações>/<intervalo>). Por exemplo:

  • 100/120s: Limita a 100 solicitações a cada 120 segundos.
  • 100/10m: Limita a 100 solicitações a cada 10 minutos.
  • 10/1h: Limita a 10 solicitações a cada 1 hora.
  • 10/1d: Limita a 10 solicitações por dia.

Deixar o campo Limite de Taxa vazio permitirá solicitações ilimitadas, mas os limites de taxa globais ainda serão aplicados.

Recursos

Cada chave de API deve ter pelo menos um recurso selecionado. Apenas os recursos selecionados serão acessíveis com a chave.