Verificar Chave
Use este endpoint para testar se sua API Key está configurada corretamente e para descobrir quais recursos estão disponíveis para o seu plano atual.
Endpoint
GET | /api/v1/verify | Sim (Bearer) |
|---|
URL Completa:
https://botgate-api-987684559046.us-central1.run.app/api/v1/verify
Resposta de Sucesso
{
"success": true,
"message": "API key is valid",
"data": {
"botId": "1234567890123456789",
"botName": "BotTeste",
"tier": {
"name": "free",
"apiCallsUsed": 1,
"apiCallsLimit": 1500,
"updateInterval": "30 minutes",
"analyticsLevel": "basic",
"historyDays": 7,
"features": {
"customWebhooks": true,
"prioritySupport": true,
"badge": "none"
}
}
}
}
Por que usar?
Pacote NPM
Se você estiver usando o pacote @botgate/stats-reporter, use o método reporter.verifyApiKey() para validar sua conexão e sincronizar o plano automaticamente.
É altamente recomendada a chamada deste endpoint durante o on_ready do seu bot para validar a conexão com o BotGate e garantir que as credenciais estão corretas antes de iniciar o loop de postagem de estatísticas.