REST API v1 · למפתחים · מדריך עיון ל-API

מדריך עיון ל-API: שרת

כל 4 נקודות הקצה של שרת ב-REST API v1 של BotGG: הרשאות, פרמטרים, שדות, שגיאות ודוגמאות מוכנות ב-curl, JavaScript ו-Python.

תיעוד למפתחים
בעמוד הזה

נקודות קצה

הנתיבים יחסיים ל-https://console.botgg.app/api/v1. שלחו את מפתח ה-API בכותרת Authorization: Bearer botgg_…; מזהים הם מחרוזות.

נקודות קצה: שרת
נקודת קצההרשאהתיאור
GET/guilds/{guildId}guild:readGet the server
GET/guilds/{guildId}/rolesguild:readList roles
GET/guilds/{guildId}/channelsguild:readList channels
GET/guilds/{guildId}/members/{userId}guild:readGet a member

מלבד השגיאות הייחודיות שלה (בהמשך), כל נקודת קצה יכולה להחזיר את השגיאות הכלליות האלה:

Get the server

GET/guilds/{guildId}

הרשאה: guild:read

Name, icon, approximate member count, the bot’s language and the enabled BotGG features.

פרמטרים
שםמיקוםסוגחובהתיאור
guildIdנתיבstringכןהמזהה של השרת שלכם · מזהה דיסקורד (מחרוזת)

תשובה

שדות התשובה · 200
שדהסוגחובהתיאור
idstringכן
namestringכן
iconstring | nullכן
iconUrlstring | nullכן
memberCountinteger | nullכןApproximate; null when Discord is unreachable
localestringכןThe bot’s language on this server (en, ru, he)
enabledFeaturesarray of stringכן
תשובה · 200
{
  "id": "example",
  "name": "Example",
  "icon": "example",
  "iconUrl": "https://example.com",
  "memberCount": 10,
  "locale": "example",
  "enabledFeatures": [
    "example"
  ]
}

דוגמאות

curl
curl -s "https://console.botgg.app/api/v1/guilds/123456789012345678" \
  -H "Authorization: Bearer $BOTGG_API_KEY"
JavaScript (fetch)
// Node.js 18+ (built-in fetch) — on your server, never in a browser
const res = await fetch('https://console.botgg.app/api/v1/guilds/123456789012345678', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.BOTGG_API_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.error}: ${data.message}`);
console.log(data);
Python (requests)
import os
import requests

res = requests.get(
    "https://console.botgg.app/api/v1/guilds/123456789012345678",
    headers={
        "Authorization": f"Bearer {os.environ['BOTGG_API_KEY']}",
    },
    timeout=10,
)
data = res.json()
if not res.ok:
    raise RuntimeError(f"{res.status_code} {data['error']}: {data['message']}")
print(data)

שגיאות

רק השגיאות הכלליות שמפורטות תחת „נקודות קצה”.

List roles

GET/guilds/{guildId}/roles

הרשאה: guild:read

Highest first (Discord order), without @everyone.

פרמטרים
שםמיקוםסוגחובהתיאור
guildIdנתיבstringכןהמזהה של השרת שלכם · מזהה דיסקורד (מחרוזת)

תשובה

שדות התשובה · 200
שדהסוגחובהתיאור
itemsarray of objectכן
items[].idstringכן
items[].namestringכן
items[].colorstring | nullכן
items[].positionintegerכן
items[].managedbooleanכן
items[].hoistbooleanכן
items[].mentionablebooleanכן
תשובה · 200
{
  "items": [
    {
      "id": "example",
      "name": "Example",
      "color": "#18d7ff",
      "position": 10,
      "managed": true,
      "hoist": true,
      "mentionable": true
    }
  ]
}

דוגמאות

curl
curl -s "https://console.botgg.app/api/v1/guilds/123456789012345678/roles" \
  -H "Authorization: Bearer $BOTGG_API_KEY"
JavaScript (fetch)
// Node.js 18+ (built-in fetch) — on your server, never in a browser
const res = await fetch('https://console.botgg.app/api/v1/guilds/123456789012345678/roles', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.BOTGG_API_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.error}: ${data.message}`);
console.log(data);
Python (requests)
import os
import requests

res = requests.get(
    "https://console.botgg.app/api/v1/guilds/123456789012345678/roles",
    headers={
        "Authorization": f"Bearer {os.environ['BOTGG_API_KEY']}",
    },
    timeout=10,
)
data = res.json()
if not res.ok:
    raise RuntimeError(f"{res.status_code} {data['error']}: {data['message']}")
print(data)

שגיאות

שגיאות
HTTPקודים
503SERVICE_UNAVAILABLE

List channels

GET/guilds/{guildId}/channels

הרשאה: guild:read

In Discord’s sidebar order (categories followed by their channels); threads are not included.

פרמטרים
שםמיקוםסוגחובהתיאור
guildIdנתיבstringכןהמזהה של השרת שלכם · מזהה דיסקורד (מחרוזת)

תשובה

שדות התשובה · 200
שדהסוגחובהתיאור
itemsarray of objectכן
items[].idstringכן
items[].namestringכן
items[].typestringכןאחד מ: text, voice, category, announcement, stage, forum, media, other
items[].parentIdstring | nullכן
items[].positionintegerכן
תשובה · 200
{
  "items": [
    {
      "id": "example",
      "name": "Example",
      "type": "text",
      "parentId": "234567890123456789",
      "position": 10
    }
  ]
}

דוגמאות

curl
curl -s "https://console.botgg.app/api/v1/guilds/123456789012345678/channels" \
  -H "Authorization: Bearer $BOTGG_API_KEY"
JavaScript (fetch)
// Node.js 18+ (built-in fetch) — on your server, never in a browser
const res = await fetch('https://console.botgg.app/api/v1/guilds/123456789012345678/channels', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.BOTGG_API_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.error}: ${data.message}`);
console.log(data);
Python (requests)
import os
import requests

res = requests.get(
    "https://console.botgg.app/api/v1/guilds/123456789012345678/channels",
    headers={
        "Authorization": f"Bearer {os.environ['BOTGG_API_KEY']}",
    },
    timeout=10,
)
data = res.json()
if not res.ok:
    raise RuntimeError(f"{res.status_code} {data['error']}: {data['message']}")
print(data)

שגיאות

שגיאות
HTTPקודים
503SERVICE_UNAVAILABLE

Get a member

GET/guilds/{guildId}/members/{userId}

הרשאה: guild:read

Basic member info: names, avatar, role ids and join date. Cached for up to 5 minutes.

פרמטרים
שםמיקוםסוגחובהתיאור
guildIdנתיבstringכןהמזהה של השרת שלכם · מזהה דיסקורד (מחרוזת)
userIdנתיבstringכןמזהה הדיסקורד של החבר/ה · מזהה דיסקורד (מחרוזת)

תשובה

שדות התשובה · 200
שדהסוגחובהתיאור
userIdstringכן
usernamestring | nullכן
globalNamestring | nullכן
nicknamestring | nullכן
displayNamestring | nullכן
avatarUrlstring | nullכן
botbooleanכן
rolesarray of stringכןRole ids
joinedAtstring | nullכן
תשובה · 200
{
  "userId": "876543210987654321",
  "username": "example",
  "globalName": "example",
  "nickname": "example",
  "displayName": "example",
  "avatarUrl": "https://example.com",
  "bot": false,
  "roles": [
    "example"
  ],
  "joinedAt": "2026-10-07T12:00:00.000Z"
}

דוגמאות

curl
curl -s "https://console.botgg.app/api/v1/guilds/123456789012345678/members/876543210987654321" \
  -H "Authorization: Bearer $BOTGG_API_KEY"
JavaScript (fetch)
// Node.js 18+ (built-in fetch) — on your server, never in a browser
const res = await fetch('https://console.botgg.app/api/v1/guilds/123456789012345678/members/876543210987654321', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.BOTGG_API_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.error}: ${data.message}`);
console.log(data);
Python (requests)
import os
import requests

res = requests.get(
    "https://console.botgg.app/api/v1/guilds/123456789012345678/members/876543210987654321",
    headers={
        "Authorization": f"Bearer {os.environ['BOTGG_API_KEY']}",
    },
    timeout=10,
)
data = res.json()
if not res.ok:
    raise RuntimeError(f"{res.status_code} {data['error']}: {data['message']}")
print(data)

שגיאות

שגיאות
HTTPקודים
404MEMBER_NOT_FOUND
503SERVICE_UNAVAILABLE

מוכנים לשדרג את השרת?

מוסיפים את BotGG בחינם ומפעילים יכולות בקונסולת הווב.