کجامجا
مستندات API
همهی درخواستها از آدرس https://api.kojamoja.ir و با کلید API در هدر x-api-key ارسال میشوند.
احراز هویت و سهمیه
- کلید را از پنل من بسازید و در هر درخواست در هدر
x-api-keyبفرستید. - هر لود نقشه (
/style.json) یا هر فراخوانی API یک درخواست حساب میشود؛ تایلها، فونتها و آیکونهای نقشه شمرده نمیشوند. - سهمیهی باقیمانده در هدرهای
X-Quota-LimitوX-Quota-Remainingهر پاسخ میآید.
نقشه
| درخواست | پاسخ |
|---|---|
GET /style.json | استایل نقشه (سازگار با MapLibre GL) |
GET /pmtiles/iran/{z}/{x}/{y}.pbf | تایل برداری (معمولاً خودکار توسط MapLibre) |
نمونهی کامل اتصال با MapLibre در صفحهی امکانات و مستندات آمده است.
مسیریابی
GET /route?point=lat,lng&point=lat,lng&profile=car
| پارامتر | توضیح |
|---|---|
point | دو بار: اول مبدأ، دوم مقصد؛ به شکل عرض,طول |
profile | car، bicycle یا foot |
curl -H "x-api-key: YOUR_KEY" \ "https://api.kojamoja.ir/route?point=35.7,51.4&point=35.8,51.45&profile=car"
پاسخ شامل هندسهی مسیر، مسافت (متر)، زمان (ثانیه) و instructionsFa (دستورالعمل فارسی گامبهگام) است.
جستوجوی مکان (Lookup)
GET /api/lookup/county — جستوجوی شهرستانها
| پارامتر | توضیح |
|---|---|
name | بخشی از نام (فارسی یا انگلیسی) |
province_id | فیلتر بر اساس استان (اختیاری) |
county_id | یک شهرستان مشخص (اختیاری) |
bbox | محدودهی جغرافیایی: minLng,minLat,maxLng,maxLat (اختیاری) |
page، limit | صفحهبندی نتایج (اختیاری) |
curl -H "x-api-key: YOUR_KEY" \ "https://api.kojamoja.ir/api/lookup/county?name=شیراز"
GET /api/lookup/cities — فهرست شهرهای ایران.
Core API
دادهی تقسیمات کشوری (استانها، شهرستانها و شهرها همراه با مرز) از مسیر /api/core — در حال تکمیل؛ مستندات کامل بهزودی منتشر میشود.
کدهای خطا
| کد | معنا |
|---|---|
401 | کلید API ارسال نشده یا نامعتبر است |
403 | کلید برای این دامنه/IP مجاز نیست، یا اعتبار کلید هدیه تمام شده |
429 | سهمیه تمام شده یا ترمز ایمنی فعال است |
502 | سرویس داخلی موقتاً در دسترس نیست (در مصرف شما شمرده نمیشود) |