Documentação para desenvolvedores

Bem-vindo à documentação para desenvolvedores do vsync. Aqui você aprende a criar aplicativos e bots, registrar comandos de barra, responder com botões, menus e formulários, usar a API REST e o gateway em tempo real e até entrar em canais de voz.

O que a plataforma oferece#

• Aplicativos e bots. Cada aplicativo tem exatamente um bot: uma conta automatizada que entra em servidores, lê mensagens e responde. Veja Visão geral de Apps.
• Comandos de barra. Comandos globais ou por servidor, com opções tipadas e opções de escolha. Veja Interações e comandos.
• Componentes e modais. Botões, menus de escolha e formulários de texto dentro das mensagens. Veja Componentes e modais.
• Mensagens e embeds. Texto com markdown, menções, emojis personalizados e cartões ricos. Veja Mensagens e embeds.
• API REST e gateway. Envie mensagens, gerencie canais, cargos e membros e receba eventos em tempo real por WebSocket. Veja a Referência.
• Voz para bots. Bots podem entrar em canais de voz e enviar áudio, como um bot de música. Veja Voz.
• Reconhecimento. Insígnia de desenvolvedor verificado e um diretório público de aplicativos. Veja Recursos de Plataforma.

Por onde começar#

1. Siga os Primeiros passos: crie um aplicativo, autorize o bot e responda a um comando de barra.
2. Leia o passo a passo detalhado e entenda a autenticação.
3. Consulte a Referência da API sempre que precisar de uma rota, um evento ou uma permissão.

O que você pode construir#

O repositório do vsync traz três bots completos que usam tudo o que está documentado aqui: um bot de boas-vindas e moderação, um bot de tickets de suporte e um bot de música. Veja Bots prontos.

Convenções desta documentação#

Os exemplos usam duas variáveis: $API, a origem da API, e $TOKEN, o token do seu bot. A origem da API e o formato do token estão em Bots. Valores como ID_DO_APP e ID_DO_SERVIDOR são marcadores: troque pelos seus.