Engagerly 2.0 · Один понятный процесс для вашего сообщества в Discord
API для разработчиков

Подключите Engagerly к своим системам

Читайте и изменяйте балансы участников, выдавайте и снимайте роли из своих приложений, игр и магазинов — с API-ключами с ограниченным доступом и полным журналом аудита.

Документация API

Premium+На Premium и Ultimate API-ключи можно создать в панели управления

REQUESTНачислите участнику 500 очков, когда он оформляет заказ.

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

Что с ним создают команды

  • Награды в игре

    Начисляйте очки, когда игроки получают достижения в вашей игре.

  • Бонусы в магазине

    Награждайте покупателей очками или VIP-ролью за заказ.

  • Отметки на мероприятиях

    Выдавайте роль всем, кто посетил живое мероприятие или вебинар.

ENDPOINTS

Четыре эндпоинта с доступом по разрешениям.

Каждый ключ ограничен областями доступа, которые вы ему выдали.

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

    Получить баланс участника в любой валюте сервера.

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

    Начислить или списать очки участнику — с необязательной заметкой и вашим собственным ID для сверки.

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

    Выдать участнику роль Discord.

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

    Снять с участника роль Discord.

    roles:write
KEYS & LIMITS

Ключи и лимиты

  • Создавайте API-ключи в панели управления на Premium или Ultimate — до 10 на сервер.
  • Передавайте ключ в заголовке X-API-Key. Каждый ключ работает только для своего сервера.
  • Выдавайте ключу только нужные области доступа: points:read, points:write или roles:write.
  • Для каждого ключа можно задать срок действия и список разрешённых IP.
  • Каждый ключ — 120 чтений и 60 записей в минуту, каждый сервер — 200 вызовов в минуту. Каждый вызов записывается в журнал аудита ключа.

Хотите узнать, что ждёт API дальше?

Новые эндпоинты сначала обсуждаются на официальном сервере Discord.

Перейти на официальный сервер Discord
READY WHEN YOU ARE

Готовы, чтобы участие
работало само?

Попробовать как участник