ربط التذاكر
عملاؤك يفتحون تذاكر الدعم ويتابعونها من تطبيقك وموقعك، وفريقك يعمل عليها من لوحة التذاكر بدخول من لوحة منصتك، وتصل منصتك إشعارات كل تغيير.
العناوين
- واجهة API
https://api-support-ticket.alhawsaba.com/api - لوحة التذاكر
https://support-tickets.alhawsaba.com
المفاتيح
- مفتاح المشروعيسمّي مشروعك في كل توكن وكل نداء.
project_key - سر التوقيع (JWT)يوقّع به سيرفرك توكنات الناس.
jwt_secret - مفتاح APIيصل مع إشعارات التذاكر ونداءاتها إلى سيرفرك لتتحقق منه، وترسله مع تحديثات الناس.
api_key
تظهر المفاتيح مرة واحدة عند إضافة الخدمة إلى المشروع، وتجدها بعد ذلك داخل الخدمة في إعدادات المشروع.
توكن الشخص
سيرفرك يوقّع توكن JWT بخوارزمية HS256 وسر التوقيع لكل شخص. حقل exp مطلوب.
| الحقل | مطلوب | المعنى |
|---|---|---|
project_key | نعم | مفتاح مشروعك. |
user_id (أو sub) | نعم | رقم الشخص عندك. |
role | نعم | user للعميل، admin لموظفك، guest لزائر دون حساب (يرى تذاكره فقط). |
exp | نعم | وقت الانتهاء. |
// npm i jsonwebtoken
import jwt from 'jsonwebtoken'
export function serviceToken(user, role) {
return jwt.sign({
project_key: process.env.ALHAWSABA_PROJECT_KEY,
user_id: String(user.id),
role, // 'user' | 'admin' | 'guest'
name: user.name,
email: user.email,
}, process.env.ALHAWSABA_JWT_SECRET, { algorithm: 'HS256', expiresIn: '7d' })
}تطبيقك وموقعك
اطلب التوكن من سيرفرك
بالدور user للعميل المسجّل، أو guest لزائر لا حساب له.
التذاكر
كلها بالترويسة Authorization: Bearer {JWT}.
- GET
/api/integration/meالشخص الحالي. - GET
/api/integration/ticket-typesأنواع التذاكر. - GET
/api/integration/ticket-categoriesالتصنيفات. - GET
/api/integration/ticketsتذاكر العميل. - POST
/api/integration/ticketsتذكرة جديدة. - GET
/api/integration/tickets/{id}تذكرة وردودها. - POST
/api/integration/tickets/{id}/replyرد العميل. - PUT
/api/integration/tickets/{id}/closeإغلاق. - PUT
/api/integration/tickets/{id}/reopenإعادة فتح. - POST
/api/integration/tickets/{id}/rateتقييم بعد الحل. - POST
/api/integration/tickets/{id}/attachmentsمرفقات. - POST
/api/integration/tickets/{id}/escalation-requestطلب تصعيد. - POST
/api/integration/filesرفع ملف.
- GET
قاعدة المعرفة قبل التذكرة
تُقرأ دون توكن بالترويسة X-Project-Key، لتعرض إجابات قبل أن يفتح العميل تذكرة.
- GET
/api/integration/kb/categoriesالأقسام. - GET
/api/integration/kb/articlesالمقالات. - GET
/api/integration/kb/suggestمقالات مقترحة لما يكتبه العميل.
- GET