مستندات API

برای ساخت توکن دسترسی، ابتدا وارد حساب کاربری خود شده و به صفحه مدیریت توکن‌ها بروید.

هر درخواست به API تا ۲۰ بار در بازهٔ ۱ دقیقه مجاز است.

• نمونه درخواست برای دریافت پست‌ها:

  curl -H "Authorization: Bearer <TOKEN>" https://dorehami.dev/api/v1/posts/

  شما می‌توانید درخواست را با پارامترهای اختیاری زیر شخصی‌سازی کنید:

  • page=1 — شماره صفحه (پیش‌فرض: 1)
  • limit=10 — تعداد آیتم‌ها در هر صفحه (پیش‌فرض: 20، حداکثر: 100)
  • sort=createdAt — مرتب‌سازی بر اساس فیلد (فیلدهای مجاز: createdAt، title، type)
  • order=desc — ترتیب مرتب‌سازی: asc یا desc (پیش‌فرض: desc)

  مثال:

  curl -H "Authorization: Bearer <TOKEN>" "https://dorehami.dev/api/v1/posts/?page=2&limit=10&sort=title&order=asc"

• نمونه درخواست برای ایجاد پست جدید:

  curl -X POST \
    -H "Authorization: Bearer <TOKEN>" \
    -H "Content-Type: application/json" \
    -d '{"title":"مثال","url":"https://example.com","type":"article"}' \
    https://dorehami.dev/api/v1/posts/

  محتوای مناسب برای این درخواست به شکل زیر است:

  {
      "title": string                 // عنوان پست، حداقل ۵ کاراکتر
      "url": string                   // لینک کامل به مطلب
      "description": string           // توضیح در مورد لینک برای خواننده‌ها تا ۵۰۰ کاراکتر (اختیاری)
      "domainIsPersonal": boolean     // آیا دامنه به شخص تعلق دارد؟ (اختیاری)
      "originalAuthorName": string    // (اختیاری) نام کامل نویسنده‌ی اصلی مطلب
      "type": enum                    // یکی از ['article', 'project', 'showcase', 'resource', 'event', 'news']
  }