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

مرجع التكامل الحالي

تُسرد فقط السلوكيات الظاهرة في التطبيق الحالي. احصل على نطاق مؤسسي مؤكد قبل الاعتماد على أي شيء آخر.

API الخادم ضمن نطاق الشركة

GET /api/companies.php

الرأس: X-API-Key: YOUR_API_KEY. يعيد {"company": {...}} للشركة المالكة للمفتاح، بالحقول id وname وwebsite وemail وphone وplan وprimary_color وsecondary_color.

GET /api/employees.php

الرأس: X-API-Key: YOUR_API_KEY. يعيد {"employees": [...]} للشركة المالكة للمفتاح، مرتبة بحسب أحدث رقم داخلي أولًا. لا توجد معاملات عامة للترقيم أو التصفية.

POST /api/employees.php

الرؤوس: X-API-Key: YOUR_API_KEY وContent-Type: application/json. حد الجسم 64 كيلوبايت. السلاسل المطلوبة: full_name وemail. الاختيارية: job_title وdepartment وphone وphone_alt وlandline وwhatsapp وlinkedin وwebsite. الاستجابة {"success":true,"id":123,"profile":"https://…"}.

مثال طلب آمن

POST /api/employees.php HTTP/1.1 X-API-Key: YOUR_API_KEY Content-Type: application/json Accept: application/json {"full_name":"Amina Hassan","email":"amina@example.com","job_title":"Sales Manager"}

أدوات القراءة العامة

GET /api/v1/public-profile.php?slug=PUBLIC_SLUG

دون بيانات اعتماد. يعيد تمثيل JSON للملف العام فقط عندما يكون الموظف والشركة مؤهلين للعرض العام. يمكن استخدام profile_id بدل slug إذا كان معرفًا عامًا مبهمًا.

GET /api/v1/vcard-link.php?slug=PUBLIC_SLUG

دون بيانات اعتماد. يعيد {"ok":true,"vcard_url":"…"} لبطاقة عامة مؤهلة. هذه أداة رابط؛ وتنزيل vCard نفسه ليس نقطة تكامل JSON.

غير ممثل كـ API عامة

مسارات بطاقة الهاتف والملف والرسائل والإشعارات وWallet وتحديثات الشركة هي عمليات للتطبيق الرسمي أو واجهات غير مكتملة/تعتمد على الإعداد، ولذلك تُستبعد عمدًا من عقد التكامل العام. لا توجد API موثقة للتزويد الجماعي أو حذف/تحديث الموظف أو SCIM أو webhook وارد.

تابع القراءة

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

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

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