Chaves da API

As Chaves da API são usadas para autorizar o acesso à API e devem ser incluídas em cada solicitação. Existem dois tipos de Chaves da API:

• Chaves da API Gratuitas (começando com ckey_..., onde c denota criptográfico)
• Chaves da API Pagas (começando com key_...)

Chaves da API Gratuitas

As Chaves da API Gratuitas podem ser criadas sem custo, proporcionando acesso limitado à API.

Condições para o uso das Chaves da API Gratuitas:

• Limitado a 200 solicitações por dia (por domínio)
• Sujeito a outros limites de taxa
• Atribuição obrigatória

Gerando uma Chave da API Gratuita

As Chaves da API Gratuitas estão vinculadas a um nome de domínio específico e só funcionam em sites hospedados no nome de domínio fornecido.

Nota

As Chaves da API Gratuitas requerem atribuição em seu site.

Gerar uma Chave da API Gratuita

Invalid response:

Sucesso! Crie algo incrível!

Download

O domínio do seu site:

Gerar

O servidor irá gerar uma nova Chave da API Gratuita e um segredo:

{
  "hostname": "exemplo.com",
  "apiKey": "ckey_49960de...",
  "secret": "csec_55de16dde79f94...",
  "licença": "..."
}

O segredo csec_... é usado para verificação de payload (como segredo HMAC) e deve permanecer confidencial, nunca exposto publicamente.

Consulte a documentação para aprender como gerar uma nova Chave da API usando a API.

Verificação de Domínio

Embora opcional, a verificação de domínio é altamente recomendada. Verificar a propriedade do seu nome de domínio via registro DNS TXT configurado com o valor fornecido altcha-verification=... adiciona uma camada extra de segurança.

A verificação de domínio garante que sua Chave de API esteja adequadamente associada ao nome de domínio com o qual é destinada a funcionar.

Para verificar o seu nome de domínio, siga estes passos:

1. Acesse o painel de gerenciamento de registros DNS.
2. Adicione um registro TXT com os seguintes detalhes:
   • Tipo de Registro: TXT
   • Host/Nome: @ (ou seu nome de domínio)
   • Valor/Texto: altcha-verification=abc... (substitua abc... pelo seu token de verificação único obtido ao gerar a Chave de API)
3. Salve as alterações.

Uma vez que o registro DNS for adicionado com sucesso e propagado, a propriedade do domínio será verificada. Isso garante o uso seguro da sua Chave de API com o nome de domínio especificado.

Atribuição para as Chaves da API Gratuitas

Ao usar a Chave da API Gratuita, é OBRIGATÓRIO exibir “Protegido por ALTCHA” junto com o logotipo no widget (ou seja, não use hidelogo ou hidefooter). Se você não estiver utilizando o widget, DEVE incluir uma atribuição no rodapé do seu site, pelo menos na página inicial:

<a href="https://altcha.org">Protegido por ALTCHA</a>

Você pode traduzir ou modificar o texto, mas ele deve transmitir um significado semelhante a “Protegido por ALTCHA”. O link deve direcionar para https://altcha.org e não deve incluir rel="nofollow".

Chaves da API Pagas

Chaves da API Pagas podem ser criadas dentro do aplicativo.