ربط المقترحات
عملاؤك يرسلون مقترحاتهم من تطبيقك وموقعك ويتابعون أين وصلت، وفريقك يعمل عليها من لوحة المقترحات، وتصل منصتك إشعارات كل تغيير.
العناوين
- واجهة API
https://api-suggestions.alhawsaba.com/api - لوحة المقترحات
https://suggestions.alhawsaba.com
المفاتيح
- مفتاح المشروعيسمّي مشروعك في كل توكن.
project_key - سر التوقيع (JWT)يوقّع به سيرفرك توكنات الناس.
jwt_secret - مفتاح APIيصل مع الإشعارات ونداءات البحث إلى سيرفرك لتتحقق منه.
api_key - سر الإشعاراتتتحقق به من توقيع كل إشعار (X-Webhook-Signature).
webhook_secret
تظهر المفاتيح مرة واحدة عند إضافة الخدمة إلى المشروع، وتجدها بعد ذلك داخل الخدمة في إعدادات المشروع.
توكن الشخص
سيرفرك يوقّع توكن JWT بخوارزمية HS256 وسر التوقيع. في المقترحات يكون رقم الشخص في الحقل sub، وصورته في image.
| الحقل | مطلوب | المعنى |
|---|---|---|
project_key | نعم | مفتاح مشروعك. |
sub | نعم | رقم الشخص عندك. |
role | يُفضَّل | user للعميل (الافتراضي)، admin لموظفك. |
name, email, phone, image | يُفضَّل | بطاقة الشخص. |
exp | يُفضَّل | وقت الانتهاء. |
// npm i jsonwebtoken
import jwt from 'jsonwebtoken'
export function serviceToken(user, role) {
return jwt.sign({
project_key: process.env.ALHAWSABA_PROJECT_KEY,
sub: String(user.id),
role, // 'user' = customer, 'admin' = staff
name: user.name,
email: user.email,
}, process.env.ALHAWSABA_JWT_SECRET, { algorithm: 'HS256', expiresIn: '7d' })
}تطبيقك وموقعك
اطلب التوكن من سيرفرك
للعميل المسجّل. لا تضع سر التوقيع في التطبيق.
المقترحات
كلها بالترويسة Authorization: Bearer {JWT}.
- GET
/api/integration/meالشخص الحالي. - GET
/api/integration/homeإعدادات الشاشة (نص الترحيب وغيره) كما ضبطها فريقك. - GET
/api/integration/suggestionsمقترحات العميل. - POST
/api/integration/suggestionsمقترح جديد. - GET
/api/integration/suggestions/{id}مقترح وحالته. - POST
/api/integration/filesرفع مرفق.
- GET