API عمومی یکه — نسخهٔ ۱

یک نقطهٔ پایانی فقط‌خواندنی و بدون نیاز به کلید، برای فهرست کسب‌وکارهای تأییدشده. منوی صفحه‌های راهنما، پژوهش‌ها و سرویس‌های خارجی می‌توانند مستقیم مصرفش کنند.

GET https://1eh.ir/api/v1/businesses

قواعد کلی

  • بدون احراز هویت و کلید؛ فقط خواندنی — هیچ اپراتوری در نسخهٔ ۱ اجازهٔ نوشتن ندارد.
  • فقط کسب‌وکارهای تأییدشده (APPROVED) برمی‌گردند؛ داده‌های مالک و وضعیت داخلی هرگز در پاسخ نیست.
  • محدودیت نرخ: ۶۰ درخواست در دقیقه از هر IP، همراه با هدر cache-control: public, max-age=300 برای مصرف‌کنندگان.
  • در وادا با قرارداد فعلی ماندنی است: فیلدها فقط اضافه می‌شوند، نام‌ها هرگز تغییر نمی‌کند — نسخهٔ بعدی در /api/v2 می‌آید.

پارامترهای پرس‌وجو

categoryدستهٔ canonical — یکی از شش شناسهٔ زیر (اختیاری)
qجستجوی متنی در نام و توضیح کسب‌وکار (اختیاری)
limitتعداد ردیف در هر پاسخ — عددی بین ۱ و ۱۰۰ (پیش‌فرض 24)
offsetشروع صفحه برای صفحه‌بندی (پیش‌فرض ۰)

شناسه‌های مجاز category:

shopsalonclinicgymentertainmentservice

نمونهٔ پاسخ موفق (200)

{
  "api_version": "v1",
  "count": 1,
  "total": 64,
  "limit": 24,
  "offset": 0,
  "businesses": [
    {
      "slug": "kafe-doodkash",
      "name": "کافه دودکش",
      "category": "shop",
      "category_fa": "کسب‌وکار",
      "gbp_primary": "food",
      "gbp_primary_fa": "غذا و نوشیدنی",
      "gbp_secondaries": ["food-cafe"],
      "description": null,
      "address": "شهر اندیشه...",
      "lat": 35.688,
      "lng": 51.024,
      "phone": "0210000000",
      "website": null,
      "verified": true,
      "level": 3,
      "rating": 4.8,
      "review_count": 12,
      "images": [{ "url": "...", "is_cover": true, "order": 0 }],
      "primary_image": "...",
      "hours": [{ "day_of_week": 0, "open_time": "09:00", "close_time": "21:00" }],
      "created_at": "2026-09-15T12:00:00.000Z",
      "updated_at": "2026-09-18T10:00:00.000Z"
    }
  ]
}

فیلدهای id داخلی، داده‌های مالک، وضعیت بازبینی، رنگ ویترین و سیاست یکه در پاسخ عمومی نیستند.

خطاها

422 invalid_categorycategory با شناسه‌های مجاز مطابقت ندارد
422 invalid_limitlimit صفر، بزرگ‌تر از ۱۰۰ یا غیرعددی است
422 invalid_offsetoffset منفی یا غیرعددی است
429 rate_limitedبیش از ۶۰ درخواست در دقیقه از یک IP