🛠️ Documentação para Desenvolvedores

A Crystal expõe uma API REST pública e somente-leitura em https://api.crystalbot.xyz/v1, autenticada por uma Crystal Key pessoal. Ela permite integrar dados do bot (estatísticas, comandos, economia, XP) em qualquer aplicação externa — outro bot, um site, um dashboard próprio.

Por onde começar

  1. Autenticação — gere sua Crystal Key e entenda como enviá-la nas requisições
  2. Referência da API — todos os endpoints disponíveis, parâmetros e respostas
  3. Exemplo: consultando economia — um passo a passo completo, do zero até o primeiro request

Conceitos rápidos

  • Base URL: https://api.crystalbot.xyz/v1
  • Autenticação: header Authorization: Bearer SUA_CRYSTAL_KEY
  • Formato: todas as respostas são JSON, sempre com um campo ok (true/false) indicando sucesso
  • Limite: até 5 Crystal Keys ativas por conta
curl https://api.crystalbot.xyz/v1/stats \
  -H "Authorization: Bearer cryst_xxxxxxxxxxxxxxxx"
{
  "ok": true,
  "ready": true,
  "users": 48213,
  "servers": 312,
  "commands": 96
}

Suas chaves

Gerencie suas Crystal Keys (criar, nomear, revogar) na página Crystal Keys — é preciso estar logado com sua conta do Discord.

Esta API é somente-leitura por enquanto e cobre um conjunto pequeno e estável de endpoints. Novos endpoints são documentados aqui assim que ficam disponíveis.