دليل البدء
من حسابك إلى أول استجابة.
افتح مساحتك
سجّل الدخول إلى وحدة التحكم ببريد إلكتروني مؤكَّد، ثم أنشئ مؤسستك أو اخترها.
فتح وحدة التحكمأنشئ مشروعًا
يجمع المشروع مفاتيحك، وتتقاسم هذه المفاتيح حدود معدل الطلبات الخاصة به.
أنشئ مفتاحًا تجريبيًا
في تبويب مفاتيح API للمشروع، اختر الصلاحية
search:readأوplaces:readومدة الصلاحية. لا يُعرض المفتاح إلا مرة واحدة: احفظه فورًا في مدير الأسرار على خادمك.جهّز البيئة
تقرأ الأمثلة
ATLAS_API_URLوATLAS_API_KEYمن البيئة. يُدخل الأمرread -rsالمفتاح دون عرضه ودون تسجيله في سجل الصدفة.read -rs ATLAS_API_KEY && export ATLAS_API_KEYيُرسَل إليك عنوان الواجهة عند فتح وصولك. عرّف حينها
ATLAS_API_URLبهذا العنوان، دون شرطة مائلة في آخره.أرسل أول طلب
استدعِ الواجهة من خادمك. فهي لا ترسل ترويسات CORS، ويجب ألا يصل المفتاح السري إلى متصفح أبدًا.
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;اقرأ الاستجابة
الاستجابة
200مجموعة معالم GeoJSON (FeatureCollection) بصيغةapplication/geo+json.- تكون قيمة
meta.statusإماokأوno_matchأوempty_catalog. - تعطي كل نتيجة موقعها بالصيغة
[longitude, latitude]وأسماءها كما يكتبها المصدر. - اعرض
meta.attributionحيثما تعرض هذه البيانات. - يتبع الخطأ صيغة Problem Details: اقرأ
codeولا تعتمد على نصه.
- تكون قيمة
بعد ذلك
- المصادقة
المفاتيح السرية التجريبية وصلاحياتها ومدة صلاحيتها وأفضل الممارسات.
- Search
البحث عن التجمعات السكانية بأسمائها، بالفرنسية أو العربية.
- Places
عرض الأماكن والبحث عنها ثم قراءة تفاصيلها.
- الأخطاء
صيغة Problem Details وكل رمز قد تعيده الواجهة.
- الحدود
معدلات الطلبات والحصص وقواعد المعاملات في البيئة التجريبية.