Skip to content
This repository has been archived by the owner on Jun 29, 2021. It is now read-only.

Rest API

LuckShiba edited this page Mar 6, 2021 · 14 revisions

Na API Rest você poderá obter os dados públicos do Zuraaa!

Os Types marcados com ? podem vim nulos ou não estar presente

Url base da API:

EndPoints:

Pegar dados de um usuário

Entradas:
  • URL:
Descrição: Exemplo:
id ID do usuário Discord 274289097689006080
Saída:
  • Código: 404 (Saída ocorre quando o usuário da id informada não existe ou não se cadastrou)
{
    "error": "O usuário {id} não foi encontrado."
}
  • Código: 200 (Usuário encontrado e dados fornecidos)
Type: Descrição:
dates Object Datas relacionadas a conta
dates.firstSeen String Data da criação da conta
dates.lastBotAdd String Data do ultimo bot que o usuário adicionou
dates.nextVote String Data da expiração do cooldown do voto do usuário
details Object Algumas informações extras do usuário
details.description String? Biografia do usuário (WIP)
_id String Id do usuário (O mesmo da url)
username String Nome de usuário do Discord
discriminator String Tag do usuario no Discord (Ex: #0001)
avatar String? Hash do avatar do discord que esta sendo exibido no Zuraaa!

Pegar dados de um usuário

Entradas:
  • URL:
Descrição: Exemplo:
id ID do usuário Discord 274289097689006080
Saída:
  • Código: 404 (Saída ocorre quando o usuário da id informada não existe ou não se cadastrou)
{
    "error": "O usuário {id} não foi encontrado."
}
  • Código: 406(Saída ocorre quando o usuário não possui bots)
[]
  • Código: 200 (Usuário encontrado e dados fornecidos)

Retorna um Array de Bots

Pegar dados de um Bot

Entradas:
  • URL:
Descrição: Exemplo:
id ID do Bot Discord 389917977862078484
Saída:
  • Código: 404 (Saída ocorre quando a é invalida ou o bot não foi cadastrado na Zuraaa!)
{
    "error": "O bot {id} não foi encontrado."
}
  • Código: 200 (Bot encontrado e dados fornecidos)
Type: Descrição:
_id String Id do usuário (O mesmo da URL)
username String Nome de Usuário do Bot no Discord
discriminator String Tag do usuário no Discord (Ex: #0001)
owner String O dono que registrou o bot no Zuraaa!
avatar String? Hash do avatar que está sendo exibido no Zuraaa!
status String Status da conta do Bot no Discord (WIP)
dates Object Datas relacionadas a conta
dates.sent String Dia do envio do Bot para o Zuraaa!
details Object Informações de exibição do Bot
details.tags String[] Categorias do bot
details.otherOwners String[] Id dos demais donos do bot
details.prefix String Prefixo do Bot
details.customInviteLink String Link customizado para o convite do bot
details.library String Biblioteca que o bot foi programado
details.shortDescription String Descrição curta do bot
details.longDescription String? Descrição longa formatada em MarkDown
details.htmlDescription String Descrição longa formatada em HTML
details.website String Site do bot
details.supportServer String Id do convite do Discord
details.customURL String? Url customiza da pagina do Bot
votes Object Votos que o bot possui
votes.current Int Numero atual dos votos do bot
votes.voteslog String[] Id das pessoas que votaram a partir de 19/09/2020