Engagerly 2.0 · Um fluxo de trabalho claro para sua comunidade no Discord
API para desenvolvedores

Conecte o Engagerly aos seus próprios sistemas

Consulte e ajuste saldos de membros e adicione ou remova cargos a partir dos seus apps, jogos e lojas — com chaves de API com escopo e um registro de auditoria completo.

Ler a documentação da API

Premium+Premium e Ultimate podem criar chaves de API no painel de controle

REQUESTAdicione 500 pontos a um membro quando ele fizer um pedido.

curl -X POST "$API_BASE/v2/open/guilds/$GUILD_ID/points/adjust" \
  -H "X-API-Key: $ENGAGERLY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "123456789012345678",
    "type": "add",
    "amount": 500,
    "note": "Order #1042 bonus",
    "ref": "order-1042"
  }'
USE CASES

O que as equipes criam com ela

  • Recompensas no jogo

    Dê pontos quando os jogadores conquistarem objetivos no seu jogo.

  • Bônus na loja

    Recompense clientes com pontos ou um cargo VIP quando fizerem um pedido.

  • Check-in em eventos

    Dê um cargo a todos que participaram de um evento ao vivo ou webinar.

ENDPOINTS

Quatro endpoints, com escopo por permissão.

Cada chave fica limitada aos escopos que você conceder.

  • GET
    /v2/open/guilds/{guild_id}/points/balance/{user_id}

    Consulte o saldo de um membro em qualquer moeda do servidor.

    points:read
  • POST
    /v2/open/guilds/{guild_id}/points/adjust

    Adicione ou deduza pontos de um membro, com uma observação opcional e seu próprio ID de referência.

    points:write
  • POST
    /v2/open/guilds/{guild_id}/members/{user_id}/roles/{role_id}

    Dê um cargo do Discord a um membro.

    roles:write
  • DELETE
    /v2/open/guilds/{guild_id}/members/{user_id}/roles/{role_id}

    Remova um cargo do Discord de um membro.

    roles:write
KEYS & LIMITS

Chaves e limites

  • Crie chaves de API no painel de controle no Premium ou Ultimate — até 10 por servidor.
  • Envie a chave no cabeçalho X-API-Key. Cada chave só funciona no próprio servidor.
  • Conceda apenas os escopos de que a chave precisa: points:read, points:write ou roles:write.
  • Se quiser, defina uma data de vencimento e uma lista de IPs permitidos para cada chave.
  • Cada chave permite 120 leituras e 60 escritas por minuto, cada servidor 200 chamadas por minuto, e toda chamada fica no registro de auditoria da chave.

Quer saber o que vem por aí na API?

Novos endpoints são discutidos primeiro no servidor oficial do Discord.

Entre no nosso servidor oficial do Discord
READY WHEN YOU ARE

Pronto para deixar a participação
andar sozinha?

Experimente como membro