Search
البحث عن التجمعات السكانية بأسمائها، بالفرنسية أو العربية.
البحث عن التجمعات السكانية
GET/v1/localities/search
يجد التجمعات السكانية باسمها أو ببداية اسمها، بالفرنسية أو العربية.
- الصلاحية المطلوبة
search:read- الاستجابة
application/geo+json
أمثلة
cURL
curl --get "$ATLAS_API_URL/v1/localities/search" \
--header "Authorization: Bearer $ATLAS_API_KEY" \
--data-urlencode 'q=أطار' \
--data-urlencode 'lang=ar' \
--data-urlencode 'limit=5'Node.js
const url = new URL("/v1/localities/search", process.env.ATLAS_API_URL);
url.search = new URLSearchParams({
q: "أطار",
lang: "ar",
limit: "5",
}).toString();
const response = await fetch(url, {
headers: { Authorization: `Bearer ${process.env.ATLAS_API_KEY}` },
});
const body = await response.json();
if (!response.ok) throw new Error(`ATLASMR ${response.status} ${body.code}`);
console.log(body.meta.status, body.features.length);PHP
<?php
$url = getenv('ATLAS_API_URL') . '/v1/localities/search?' . http_build_query([
'q' => 'أطار',
'lang' => 'ar',
'limit' => '5',
], '', '&', PHP_QUERY_RFC3986);
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ATLAS_API_KEY')],
]);
$body = json_decode(curl_exec($curl), true, 512, JSON_THROW_ON_ERROR);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
if ($status !== 200) {
throw new RuntimeException("ATLASMR {$status} {$body['code']}");
}
echo $body['meta']['status'], ' ', count($body['features']), PHP_EOL;تقرأ الأمثلة ATLAS_API_URL وATLAS_API_KEY من بيئة خادمك.
المعاملات
| المعامل | القواعد | الوصف |
|---|---|---|
q |
| الاسم المطلوب أو بدايته. |
lang |
| اللغة المفضلة للاسم المعروض. |
limit |
| الحد الأقصى لعدد النتائج. |
الاستجابة
في المجموعة، تصف الحقول id وgeometry وproperties كل عنصر من features.
| الحقل | الوصف |
|---|---|
features | النتائج، بالترتيب الذي تعيده الواجهة. |
geometry.coordinates | الموقع [longitude, latitude] بنظام WGS84. |
properties.display | الاسم المعروض (text وlanguage وsource_tag وfallback)، أو null لمكان بلا اسم. |
properties.names | الأسماء التي يوفرها المصدر حسب وسم اللغة، دون أي ترجمة. |
properties.category.code | locality.<type> للتجمع السكاني، وإلا فهي فئة المكان. |
properties.reference | مرجع OSM (source وtype وid وkey). قد يتغير من فهرس إلى آخر. |
properties.match | كيف وجد الطلب هذه النتيجة: type المطابقة والاسم المطابق. |
meta.status | ok عند وجود نتائج، وإلا no_match؛ وempty_catalog لفهرس تجمعات سكانية فارغ. |
meta.count | عدد النتائج المعادة. |
meta.catalog.notices | تنبيهات حول الفهرس، ينبغي أن تعكسها واجهتك. |
meta.attribution | الإشارة التي يجب عرضها حيثما تعرض هذه البيانات. |
الأخطاء
تتبع جميع الأخطاء صيغة Problem Details.
التنبيهات والإشارة إلى المصدر
تذكر كل استجابة تنبيهاتها في meta.catalog.notices:
experimental_catalog- فهرس تجريبي: قد يتغير محتواه وشكله.
partial_coverage- تغطية جزئية: قد يوجد مكان غير مدرج.
unverified_source- بيانات مصدر لم تتحقق منها ATLASMR.
not_linked_to_map_release- غير مرتبط بإصدار الخريطة: قد تختلف المواقع والأسماء عن الخريطة الأساسية.
مصدر البيانات OpenStreetMap، بترخيص ODbL 1.0. اعرض هذه الإشارة مع رابطها حيثما تعرض البيانات: