امکانات نقشه و مستندات فنی

آنچه پلتفرم کجامجا در اختیار شما می‌گذارد و نحوه‌ی اتصال به آن.

امکانات

نقشه‌ی برداری ایران

تایل‌های برداری (PMTiles) با برچسب‌های فارسی و استایل قابل‌سفارشی‌سازی با رنگ برند شما.

مسیریابی سه‌گانه

مسیر بهینه برای خودرو، دوچرخه و پیاده با مسافت و زمان تقریبی.

دستورالعمل فارسی

راهنمای پیچ‌به‌پیچ مسیر به فارسی، آماده برای راهنمای صوتی.

جست‌وجوی مکان

یافتن سریع شهر، استان و محدوده‌ی هر مختصات (Lookup).

داده‌ی تقسیمات کشوری

شهرها و استان‌های ایران همراه با مرز و مختصات (Core API).

کاملاً مستقل و آفلاین

بدون وابستگی به اینترنت بین‌المللی؛ در پلن طلایی قابل نصب روی سرور خودتان.

امن از پشت Gateway

همه‌ی سرویس‌ها فقط با کلید API و از پشت یک درگاه یکپارچه در دسترس‌اند.

مصرف شفاف

هدرهای استاندارد RateLimit در هر پاسخ و داشبورد مصرف در پنل.

احراز هویت

همه‌ی درخواست‌ها باید کلید API را در هدر x-api-key (یا پارامتر api_key) ارسال کنند:

curl -H "x-api-key: YOUR_KEY" https://api.kojamoja.ir/style.json

نمایش نقشه (MapLibre)

استایل نقشه از /style.json و تایل‌ها از /pmtiles/{archive}/{z}/{x}/{y} دریافت می‌شوند. با MapLibre GL JS:

const map = new maplibregl.Map({
  container: 'map',
  style: 'https://api.kojamoja.ir/style.json',
  transformRequest: (url) => ({ url, headers: { 'x-api-key': 'YOUR_KEY' } }),
})

مسیریابی

GET /route?point=lat,lng&point=lat,lng&profile=car|bicycle|foot — نقطه‌ی اول مبدأ و نقطه‌ی دوم مقصد است. پاسخ شامل هندسه‌ی مسیر، مسافت (متر)، زمان (ثانیه) و instructionsFa (دستورالعمل فارسی) است.

curl -H "x-api-key: YOUR_KEY" \
  "https://api.kojamoja.ir/route?point=35.7,51.4&point=35.8,51.45&profile=car"

جست‌وجو و داده‌ی کشوری

Lookup از مسیر /api/lookup و Core API از مسیر /api/core در دسترس‌اند. ساختار کامل درخواست و پاسخ در مستندات API آمده است.

محدودیت‌ها و خطاها

کدمعنا
401کلید API ارسال نشده یا نامعتبر است
429سقف مصرف یا نرخ درخواست تمام شده؛ هدرهای RateLimit-* زمان بازنشانی را نشان می‌دهند
502سرویس داخلی موقتاً در دسترس نیست (در مصرف شما شمرده نمی‌شود)