U یونیوم مستندات

پنل و حساب

کلید API و مجوزها

کلید API در یونیوم همان token مسیر Bot API است و باید مثل secret نگهداری شود.

ساخت کلید

curl -X POST "https://api.uniom.ir/api_keys" \
  -H "Authorization: Bearer <JWT>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "server-main",
    "credential_id": 42,
    "scopes": ["bot:send", "bot:receive"],
    "expires_in_days": 90
  }'

مقدار خام کلید را فقط همان لحظه ذخیره کنید. بعداً فقط preview کلید نمایش داده می‌شود.

صفحه کلیدهای API در پنل یونیوم
فهرست کلیدهای API، وضعیت آن‌ها و حساب لینک‌شده در پنل یونیوم.

استفاده از کلید

در متدهای منطبق بر APIهای تلگرام، کلید داخل مسیر می‌آید:

/bot<API_KEY>/sendMessage

برای APIهای پنل، معمولاً از header احراز هویت استفاده می‌شود:

Authorization: Bearer <JWT>

یا در مسیرهایی که Personal Access Token را می‌پذیرند:

Authorization: apikey <PAT>

فهرست و حذف کلیدها

curl "https://api.uniom.ir/api_keys" \
  -H "Authorization: Bearer <JWT>"
curl -X DELETE "https://api.uniom.ir/api_keys/123" \
  -H "Authorization: Bearer <JWT>"

پیشنهاد امنیتی

برای محیط test و production کلید جدا بسازید، تاریخ انقضا بگذارید، و scope را به حداقل کاری که برنامه لازم دارد محدود کنید. کلید Bot API را در کد frontend قرار ندهید.