Engagerly 2.0 · Un parcours clair pour ta communauté Discord
API développeur

Connecte Engagerly à tes propres systèmes

Consulte et ajuste les soldes des membres, ajoute ou retire des rôles depuis tes applications, jeux et boutiques, avec des clés API à portée limitée et un journal d'audit complet.

Lire la documentation de l'API

Premium+Premium et Ultimate peuvent créer des clés API dans le tableau de bord

REQUESTAjouter 500 points à un membre quand il passe commande.

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

Ce que les équipes en font

  • Récompenses en jeu

    Donne des points quand les joueurs débloquent des succès dans ton jeu.

  • Bonus d'achat

    Récompense tes clients avec des points ou un rôle VIP quand ils passent commande.

  • Check-ins d'événements

    Attribue un rôle à tous ceux qui ont assisté à un live ou à un webinaire.

ENDPOINTS

Quatre endpoints, limités par permission.

Chaque clé est limitée aux portées d'accès que tu lui accordes.

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

    Obtenir le solde d'un membre dans n'importe quelle monnaie du serveur.

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

    Ajouter ou retirer des points à un membre, avec une note facultative et ton propre identifiant de référence.

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

    Attribuer un rôle Discord à un membre.

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

    Retirer un rôle Discord à un membre.

    roles:write
KEYS & LIMITS

Clés et limites

  • Crée des clés API dans le tableau de bord avec Premium ou Ultimate, jusqu'à 10 par serveur.
  • Envoie la clé dans l'en-tête X-API-Key. Chaque clé ne fonctionne que pour son propre serveur.
  • N'accorde à une clé que les portées d'accès nécessaires : points:read, points:write ou roles:write.
  • Définis si tu veux une date d'expiration et une liste d'IP autorisées pour chaque clé.
  • Chaque clé permet 120 lectures et 60 écritures par minute, chaque serveur 200 appels par minute, et chaque appel est consigné dans le journal d'audit de la clé.

Envie de savoir ce qui arrive pour l'API ?

Les nouveaux endpoints sont d'abord discutés sur le serveur Discord officiel.

Rejoindre notre serveur Discord officiel
READY WHEN YOU ARE

Prêt à laisser la participation
tourner toute seule ?

Essayer en tant que membre