Comece aqui
Autenticação
Toda chamada leva sua chave de API no corpo da requisição. A chave identifica a conta, aplica o limite de taxa dela e restringe cada ação aos dados dessa conta.
Onde colocar a chave
Passe a chave como o campo key no corpo da requisição codificado como formulário. Autenticação por cabeçalho não é suportada — a especificação v2 usa parâmetros no corpo para compatibilidade com os SDKs de revenda existentes.
Content-Type: application/x-www-form-urlencoded
key=YOUR_API_KEY&action=servicesComo enviar uma requisição
Envie um POST com campos de formulário (application/x-www-form-urlencoded) ou com um objeto JSON com os mesmos nomes simples. O corpo pode ter no máximo 32 KB. Parâmetros desconhecidos são ignorados, e um valor vazio conta como ausente. Qualquer outro método é recusado com METHOD_NOT_ALLOWED.
O que é verificado em cada requisição
A chave, a conta e a chave geral da API são verificadas de novo a cada chamada, então uma conta suspensa ou uma chave revogada deixa de funcionar na hora. A conta precisa estar ativa e ter o e-mail verificado.
- 401
INVALID_KEY
Invalid API keyA chave está ausente, errada ou revogada. Corrija a requisição primeiro.
- 403
INACTIVE_ACCOUNT
Account suspendedA conta está suspensa. Corrija a requisição primeiro.
- 403
EMAIL_UNVERIFIED
Email verification requiredO e-mail da conta ainda não foi verificado. Corrija a requisição primeiro.
- 503
API_DISABLED
The API is temporarily disabledA API está desligada por um curto período. Retry-After diz quando tentar de novo. Tentar de novo pode ajudar.
- 405
METHOD_NOT_ALLOWED
Use POSTA requisição não era um POST. Corrija a requisição primeiro.
- 413
BODY_TOO_LARGE
Request body too largeO corpo da requisição é grande demais. Corrija a requisição primeiro.
key=YOUR_API_KEY&action=balance{
"error": "Invalid API key",
"error_code": "INVALID_KEY",
"retryable": false
}Criar e substituir chaves
As chaves são geradas e revogadas em /dashboard/api. A chave original é mostrada exatamente uma vez. O servidor conserva um verificador unidirecional e um identificador curto não secreto, por isso o valor original não pode ser recuperado depois.
Máximo de 5 chaves ativas
por conta. Chaves antigas podem ser revogadas individualmente.Substitua sem interrupção.
Crie uma chave de substituição, atualize a integração e depois revogue a chave antiga. Novos pedidos com chaves revogadas são rejeitados.É necessária uma sessão ativa do painel.
A geração exige uma sessão autenticada e sem representação no painel. Não acrescenta outro pedido de código por e-mail nem de senha.
O que uma chave de API não pode fazer
Uma chave de API v3 limita-se às ações documentadas e não pode acessar uma sessão iniciada no painel nem dados de outras contas.
- Sacar ou transferir saldo.
- Alterar o e-mail, a senha ou as configurações de 2FA da conta.
- Gerar ou revogar outras chaves API através da API.
- Acessar endpoints de admin ou de moderação.
Mantenha sua chave segura
- Apenas no servidor. Nunca embuta uma chave de API em um bundle de navegador, aplicativo mobile ou qualquer cliente que outra parte possa descompilar.
- Use variáveis de ambiente. Não faça commit de chaves no git. Arquivos
.envpertencem ao.gitignore. - Revogue em caso de suspeita. Se uma chave aparecer num registo, captura de ecrã ou conversa partilhada, crie uma substituta e revogue a chave exposta.
- Use webhooks para reduzir consultas quando for útil. A entrega é de melhor esforço com novas tentativas; mantenha handlers idempotentes e reconcilie estados importantes com
action=status.