Skip to main content
مستندات

مستندات API

هر آنچه برای افزودن مدیریت محتوای Discuse به اپلیکیشن خود نیاز دارید. API ساده مبتنی بر REST، قابلیت‌های کامل و دقتی در سطح پیشروان صنعت.

Endpointهای API

مروری سریع بر Endpointهای API در دسترس. همه Endpointها JSON می‌پذیرند و پاسخ‌ها را به‌صورت JSON برمی‌گردانند.

POST/api/v2/check

بررسی کامل مدیریت محتوا با همه قابلیت‌های فعال.

POST/api/v2/demo/check

Endpoint دموی عمومی (با محدودیت نرخ، بدون نیاز به کلید API).

POST/api/v2/scan

اسکن فایل‌ها برای بدافزار و ویروس.

POST/api/v2/ocr

استخراج متن از تصاویر و PDFs، همراه با مدیریت محتوای اختیاری.

POST/api/v2/summarize

تولید خلاصه‌ای کوتاه و دقیق از یک سند.

POST/api/v2/demo/ocr

دموی عمومی OCR (با محدودیت نرخ، بدون کلید API؛ PDFs تا 20 صفحه).

POST/api/v2/demo/summarize

دموی عمومی خلاصه‌سازی (با محدودیت نرخ، بدون کلید API؛ PDFs تا 20 صفحه).

URL پایه

همه درخواست‌های API باید به URL پایه زیر ارسال شوند:

https://api.discuse.com

احراز هویت

درخواست‌های API خود را با قرار دادن کلید API در هدر درخواست احراز هویت کنید.

X-API-Key: your_api_key_here

کلید API ندارید؟ از اینجا شروع کنید تا یکی بسازید.

فرمت پاسخ

همهٔ پاسخ‌های API از یک ساختار JSON یکسان پیروی می‌کنند:

{
  "has_violations": false,
  "cached": false,
  "message": "Content appears safe",
  "results": {
    "hits": false,
    "sentiment": {
      "hit": false,
      "toxic": 0.02,
      "profanity": 0.01,
      "threat": 0.00,
      "insult": 0.03
    },
    "spam_finder": {
      "is_spam": false,
      "confidence": 0.05
    },
    "language": {
      "detected": "en",
      "confidence": 0.98
    }
  },
  "processing_time_ms": 45,
  "usage": {
    "api_requests_used": 150,
    "api_requests_limit": 10000,
    "api_requests_remaining": 9850
  }
}

آماده شروع هستید؟

راهنمای شروع ما را دنبال کنید و در چند دقیقه، مدیریت محتوای خود را یکپارچه کنید.

شروع یکپارچه‌سازی