مستندات API حق فراموش شدن
درخواستها GET هستند، کلید نمیخواهند و پاسخ JSON میدهند.
مسیرها
# بررسی سلامت
curl -fSsL 'https://rtbf.ir/api/v1/'
# همهٔ سرویسها
curl -fSsL 'https://rtbf.ir/api/v1/services/'
# یک سرویس با دامنهٔ ثبتشده
curl -fSsL 'https://rtbf.ir/api/v1/services/aparat.com'
# فیلتر
curl -fSsL 'https://rtbf.ir/api/v1/services/category=e-commerce&priority=2&status=medium-label&sort=oldest'
فیلترها و صفحهبندی
ترتیب فیلترها را مثل نمونه نگه دارید؛ ? اضافه نکنید.
مقدار all محدودیت دستهبندی، اولویت یا وضعیت را برمیدارد.
| فیلتر | مقدار |
|---|---|
category | all یا دستههای
filters.category در پاسخ سلامت |
priority | all، 1، 2 یا 3 |
status | all، easy-label،
medium-label، hard-label یا impossible-label |
sort | newest یا oldest |
نتیجه در data و تعداد کل در meta.total است.
فهرست فیلترشده در صفحههای ۲۰تایی میآید؛ links.next و
links.previous مسیر صفحهٔ بعد و قبل هستند.
# صفحهٔ دوم
curl -fSsL 'https://rtbf.ir/api/v1/services/category=all&priority=all&status=all&sort=newest&page=2'
نتیجهٔ خالی data: [] میدهد؛ مسیر نامعتبر یا دامنهٔ ثبتنشده، خطای 404.
برای هدر application/json، در دو مسیر اول index.json
و در مسیرهای دیگر .json اضافه کنید.