مرجع الـ API

جميع دوال واجهة Gurdx ومدخلاتها واستجاباتها والقواعد المشتركة بين كل الطلبات.

نظرة عامة#

واجهة Gurdx مجموعة من دوال HTTP لفحص عناوين IP والبريد الإلكتروني وأرقام الجوال والبطاقات والآيبان والنطاقات والنصوص وعمليات الدفع الكاملة بحثًا عن مؤشرات الاحتيال. تستخدم كل دالة غلاف الاستجابة نفسه ورموز الأخطاء المرقّمة نفسها.

تُرسَل جميع الطلبات إلى https://gurdx.cretip.com/api، مثل https://gurdx.cretip.com/api/lookup/ip. تعرض كل صفحة أدناه مسار الدالة والباقات التي تشملها ومعاملاتها ومثالًا قابلًا للتشغيل بأربع لغات.

قواعد مشتركة بين كل الدوال#

• المصادقة. أرسل مفتاحك في المعامل key أو في الترويسة Authorization: Bearer <key>. المفاتيح التي تبدأ بـ gx_test_ هي مفاتيح اختبار.
• الخيارات المشتركة. تقبل كل دالة format (JSON أو XML أو CSV أو Newline) وlang وmode (live أو test) وcallback (JSONP مع صيغة JSON فقط) وuserID وهو معرّف حر يربط الطلب بأحد مستخدميك في سجل الأحداث. والدوال التي تُرجع وحدات تقبل أيضًا params؛ راجع تخصيص الوحدات.
• غلاف النجاح. يُرجع الطلب الناجح {"data": ..., "status": "success", "executionTime": <ms>}. وتوصَف بنية data في صفحة كل دالة.
• الأخطاء تصل مع HTTP 200. يردّ الطلب الفاشل أيضًا بحالة 200 وجسم على الشكل {"status": "error", "code": 119, "type": "invalid_email_address", "description": "..."}. افحص دائمًا الحقل status ولا تكتفِ برمز HTTP. الرموز من 101 إلى 127 هي المجموعة الأساسية، ثم 128 (invalid_domain) و129 (invalid_text) و130 (invalid_payment_data) إضافات لاحقة.
• وضع الاختبار. مع mode=test أو مفتاح gx_test_ تحصل على بيانات وهمية واقعية الشكل دون استهلاك الحصة ودون إطلاق أحداث ودون الاتصال بأي خدمة خارجية. استخدمه أثناء بناء التكامل.
• الفوترة. يُحتسب كل طلب كطلب واحد من حصتك الشهرية، عدا حذف بيانات مستخدم فهو مجاني.

ترتيب الفحوص#

يمر كل طلب بالمسار نفسه: التحقق من الخيارات أولًا، ثم المفتاح، ثم حالة الحساب والاشتراك، فالمضيفات المصرّح بها، ثم هل تشمل باقتك الدالة، ثم الحماية من الإغراق، وأخيرًا الحصة. أول فشل يحدد رمز الخطأ الذي تستلمه.

القواعد والقوائم والأحداث#

الدوال التي تقيّم عنصرًا ما يمكنها تطبيق قواعدك المخصصة وقوائمك السوداء، ويمكنها إطلاق أحداث تستقبلها عبر الويب هوك. تذكر كل صفحة ما ينطبق عليها.

جميع الدوال#