1.0.0 • Published 4 years ago

system-api v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
4 years ago

SystemAPI 1.0.0

Simples api para os usuarios de SystemAPP criarem seus projetos usando nossa plataforma. Caso você não seja um usuario SystemAPP basta clicar aqui e se registrar.

Sobre SystemAPP

SystemAPP é um site de interação online, aonde você pode criar grupos e servidores para se divertir com seus amigos. Em um grupo você o configura em nosso site no menu do grupo, tendo o limite de 10 membros e configurações basicas. Já um servidor tem o limite de 100 membros, e você pode não só configura-lo em nosso painel de configuração, como tambem pode criar um Client e o configurar por codigo

Ajuda:

Conexão de Client ao Servidor

Para fazer uma conexão com seu codigo, primeiro você precisará acessar nossa central de desenvolvimento e gerar um client para pegar seu token

Após isso, crie uma pasta e gere uma package.json dentro dela usando npm init -y, com a sua package.json gerada, baixe nossa api usando npm install system-api --save, depois disso crie um arquivo chamado index.js

Chame nossa api igual o exemplo abaixo:

const system = require("system-api")

Agora é só usar o token gerado na central de desenvolvimento para criar um Client:

const system = require("system-api")
const client = new system.Client("token gerado")

Tudo pronto para ligar seu codigo, mas antes precisamos adicionar o metodo de conexão

const system = require("system-api")
const client = new system.Client("token gerado")

client.start()

Com o Metodo adicionado, você só precisa ir em seu terminal e executar node index.js e já estará ligado seu Client.

Eventos Gerais

Os Eventos podem ajudar você a criar varias funções e sistemas legais em seu servidor

Sendo simples você só precisa escolher um e adicionar uma função a ele

const system = require("system-api")
const client = new system.Client("token gerado")

client.on("ready", () => {
  //Codigo...
})

client.start()

Este é um evento muito conhecido, que é ativado quando seu bot conecta com sucesso ao SystemAPP

Além deste temos varios outros, como...

Evento Logs

Evento ativado em qualquer alteração em seu client

const system = require("system-api")
const client = new system.Client("token gerado")

client.on("logs", log => {
  console.log(log.text)
})

client.start()

Este evento retorna 3 valores, sendo eles type que é o tipo do log, event o nome do log e text que é a mensagem que o log traz

type

  • 1 - Alteração na conexão
  • 2 - Mensagem direta do servidor
  • 3 - Log de aviso global do SystemAPP

event

  • client.login - Ativado ao Executar a função de start()
  • client.error - Qualquer erro que tiver com seu client

    Nota: As vezes pode ser enviado mais de um log

1.0.0

4 years ago