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

4つのエンドポイントを、権限ごとのスコープで。

各キーは付与したスコープの範囲内でのみ使えます。

  • 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

キーと上限

  • PremiumまたはUltimateでは、ダッシュボードでAPIキーを作成できます。サーバーごとに最大10個です。
  • キーはX-API-Keyヘッダーで送信します。各キーは自分のサーバーでのみ使えます。
  • キーには必要なスコープだけを付与します：points:read、points:write、roles:write。
  • キーごとに有効期限とIP許可リストを任意で設定できます。
  • キーごとに毎分120回の読み取りと60回の書き込み、サーバーごとに毎分200回の呼び出しまで。すべての呼び出しはキーの監査ログに記録されます。

APIの今後の予定を知りたいですか？

新しいエンドポイントは、まず公式Discordサーバーで議論されます。

公式Discordサーバーに参加
READY WHEN YOU ARE

参加の盛り上がりを、
自動で回しませんか？

メンバーとして試す