Reference · Getting Started

البدء

مرحبًا بك في واجهة Oolel Maps البرمجية. يرشدك هذا الدليل إلى إنشاء حسابك والحصول على مفتاح API وإرسال طلبك الأول.

نظرة عامة

توفر Oolel Maps واجهة REST للترميز الجغرافي والبحث والملاحة عبر غرب إفريقيا. جميع النقاط تحت البادئة /api/v1، تُرجع JSON وتدعم الفرنسية والعربية والإنجليزية عبر معامل اللغة.

عنوان القاعدة

https://api.oolelmaps.com/api/v1
1

أنشئ حسابك

توجه إلى صفحة التسجيل وأنشئ حساب مطور مجاني. ستحتاج إلى عنوان بريدك الإلكتروني وكلمة مرور، واختياريًا اسم شركتك.

2

أنشئ مفتاح API

بعد تسجيل الدخول، انتقل إلى قسم مفاتيح API في لوحة التحكم. انقر على «إنشاء مفتاح جديد» وامنحه اسمًا وصفيًا (مثال: «إنتاج» أو «تطوير»). انسخ مفتاحك وخزّنه بأمان — لن يُعرض مرة أخرى بعد الإنشاء.

3

أرسل طلبك الأول

استخدم مفتاح API في الترويسة Authorization مع البادئة Bearer. فيما يلي طلب ترميز جغرافي أمامي بسيط:

cURLbash
curl -X GET "https://api.oolelmaps.com/api/v1/geocode/forward?address=Tevragh+Zeina+Nouakchott" \
  -H "Authorization: Bearer YOUR_API_KEY"

المصادقة

يجب أن تتضمن كل طلبات API مفتاحك في الترويسة Authorization:

Header Formattext
Authorization: Bearer YOUR_API_KEY

تتلقى الطلبات التي لا تحمل مفتاحًا صالحًا استجابة 401 Unauthorized.

حدود المعدل

يُطبَّق throttling عام على كل مفتاح API لمنع إساءة الاستخدام. إذا تجاوزت الحد، ترد الواجهة بـ 429 Too Many Requests. تواصل مع الدعم إذا احتاج عبء الإنتاج لديك طاقة أعلى.

Rate Limit Headerstext
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 97
X-RateLimit-Reset: 1709683200

معالجة الأخطاء

تستخدم الواجهة رموز HTTP القياسية. تتضمن استجابات الخطأ جسم JSON مع رسالة وصفية:

Error Responsejson
{
  "statusCode": 400,
  "message": "Query parameter 'address' is required",
  "error": "Bad Request"
}
الرمزالوصف
200نجاح الطلب
400طلب غير صالح (معاملات مفقودة أو غير صحيحة)
401غير مخوَّل (مفتاح API مفقود أو غير صالح)
429تم تجاوز حد المعدل
500خطأ داخلي في الخادم

دعم اللغات

تقبل معظم النقاط معامل language للتحكم بلغة الاستجابة. القيم المدعومة:

fr

الفرنسية (الافتراضية)

ar

العربية

en

الإنجليزية