المصادقة

المفاتيح السرية التجريبية وصلاحياتها ومدة صلاحيتها وأفضل الممارسات.

الترويسة Authorization

أرسل المفتاح مع كل طلب في الترويسة Authorization بالمخطط Bearer.

Authorization: Bearer $ATLAS_API_KEY

يبدأ المفتاح التجريبي بـ atlas_sk_sandbox_ ويتبعه 43 حرفًا ورقمًا. لا تعرض وحدة التحكم بعد ذلك إلا البادئة وآخر أربعة أحرف.

يتلقى كل مفتاح صلاحياته عند إنشائه، ولا تتغير بعد ذلك. يُرد على أي مسار يُطلب دون الصلاحية اللازمة بـ 403 insufficient_scope.

الصلاحيات
الصلاحية	المسارات	الحالة
`search:read`	البحث عن التجمعات السكانية. `GET /v1/localities/search`	متاحة
`places:read`	الأماكن: القائمة والبحث والتفاصيل. `GET /v1/places/search` `GET /v1/places` `GET /v1/places/osm/{type}/{id}`	متاحة
`maps:read`	بلاطات الخريطة وأنماطها. لا يقبلها أي مسار بعد.	غير متاحة بعد

تنتهي صلاحية كل مفتاح بعد 30 أو 90 أو 365 يومًا، و90 يومًا افتراضيًا.
يحتفظ المشروع بـ 5 مفاتيح نشطة على الأكثر.
يتلقى المفتاح المنتهي أو الملغى أو غير المعروف الاستجابة نفسها: 401 invalid_api_key.
يتطلب إنشاء مفتاح دور مالك أو مسؤول أو مطوّر وبريدًا إلكترونيًا مؤكَّدًا.
يلغي المالكون والمسؤولون أي مفتاح في المشروع، ويلغي المطوّر مفاتيحه فقط.

أخطاء المصادقة
الحالة	الرمز	المعنى	ما العمل
`401`	`missing_api_key`	لا يوجد مفتاح في الترويسة `Authorization`.	أرسل `Authorization: Bearer` متبوعًا بالمفتاح.
`401`	`invalid_api_key`	مفتاح غير معروف أو غير صالح الصيغة أو منتهٍ أو ملغى، أو مشروع غير نشط.	تحقق من المفتاح في وحدة التحكم أو أنشئ مفتاحًا آخر.
`403`	`insufficient_scope`	لا يملك المفتاح الصلاحية التي يتطلبها هذا المسار.	أنشئ مفتاحًا بهذه الصلاحية.
`503`	`service_unavailable`	لم يُفتح الوصول التجريبي لمفاتيح المشروع بعد.	انتظر فتح وصولك دون إعادة المحاولة بشكل متكرر.