وثائق المطور وAPI

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

تختلف أغلفة الأخطاء بين API الشركة والأدوات العامة/الهاتف v1. يجب فحص حالة HTTP وJSON معًا بدل افتراض مخطط موحد.

استجابات API الشركة

401

يحتوي JSON على سلسلة error عند غياب المفتاح أو عدم صلاحيته أو عدم توفر دعم المفاتيح المجزأة.

403

قد تعيد صلاحية الخطة سلسلة error. وتعيد قيود دورة الحياة success:false وok:false ورمز COMPANY_SUSPENDED أو COMPANY_FROZEN أو COMPANY_DEACTIVATED ورسالة عامة آمنة وكائن error داخلي.

400 / 405 / 429

تستخدم أخطاء التحقق والإنشاء 400، والطرق غير المدعومة للموظفين 405، وقد يستخدم تقييد محاولات المصادقة 429. لا يوجد ضمان عام لحد رقمي أو رؤوس استجابة.

استجابات أدوات v1 العامة

تعيد هذه الأدوات {"ok":false,"error":{"code":"…","message":"…"}}. الرموز الفعلية في الأدوات الموثقة هي profile_not_found وemployee_not_found وmethod_not_allowed وservice_unavailable. لا تطبق رموز تسجيل دخول الهاتف على تكامل API الشركة.

استراتيجية العميل

سجّل معرف ارتباط من نظامك وحالة HTTP ورمز/رسالة آمنة والوقت، دون بيانات اعتماد أو حمولات شخصية. لا تُعد محاولة أخطاء التحقق أو المصادقة أو الخطة أو دورة الحياة تلقائيًا. استخدم تراجعًا محدودًا لحالات 429 أو 503 المؤقتة، لكن CardIQ لا يضمن Retry-After.

تابع القراءة

تحكّم في كيفية تمثيل الموظفين لشركتك خارجيًا

استكشف منصة CardIQ أو راجع سير العمل من التحقق إلى إلغاء الهوية.

كيف يعمل CardIQ عرض الأسعار