توثيق API
API متاحة فقط للباقة الاحترافية - احصل على مفتاح API الخاص بك
المصادقة
أضف مفتاح API في header كل طلب:
X-API-Key: nl_your_api_key_here
GET
/api/v1/lookup/number
البحث عن رقم هاتف مع رمز الدولة
المعاملات
| المعامل | النوع | مطلوب | الوصف |
|---|---|---|---|
| number | string | نعم | رقم الهاتف |
| code | string | نعم | رمز الدولة (مثل: 967) |
مثال الطلب
GET /api/v1/lookup/number?number=781738173&code=967
X-API-Key: nl_xxxxxxxxxxxxxxxx
مثال الاستجابة
{
"success": true,
"data": {
"query_type": "number",
"phone": "781738173",
"country_code": "967",
"total_results": 3,
"data": [
{ "CONTACT_NAME": "اصيل", "ContactPhoneNumber": "781738173" }
],
"cached": false,
"response_time_ms": 245.5
}
}
GET
/api/v1/lookup/name
البحث عن اسم والحصول على الأرقام المرتبطة
المعاملات
| المعامل | النوع | مطلوب | الوصف |
|---|---|---|---|
| name | string | نعم | الاسم المراد البحث عنه |
مثال الطلب
GET /api/v1/lookup/name?name=سامي منير
X-API-Key: nl_xxxxxxxxxxxxxxxx
مثال الاستجابة
{
"success": true,
"data": {
"query_type": "name",
"name": "سامي منير",
"total_results": 112,
"data": [
{ "name": "سامي منير", "number": "737859242" }
],
"cached": false,
"response_time_ms": 312.8
}
}
حدود الطلبات (Rate Limits)
كل مفتاح API له حد طلبات محدد يمكن تخصيصه. القيمة الافتراضية: 1000 طلب/ساعة
Headers في الاستجابة:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1620000000
رموز الأخطاء
| الرمز | المعنى |
|---|---|
| 200 | نجاح |
| 400 | طلب غير صالح |
| 401 | غير مصادق - API Key مفقودة أو غير صالحة |
| 403 | ممنوع - ليس لديك صلاحية |
| 429 | تم تجاوز حد الطلبات |
| 500 | خطأ في الخادم |