كل أدلة الربط

ربط المقترحات

عملاؤك يرسلون مقترحاتهم من تطبيقك وموقعك ويتابعون أين وصلت، وفريقك يعمل عليها من لوحة المقترحات، وتصل منصتك إشعارات كل تغيير.

العناوين

  • واجهة APIhttps://api-suggestions.alhawsaba.com/api
  • لوحة المقترحاتhttps://suggestions.alhawsaba.com

المفاتيح

  • مفتاح المشروعproject_key
    يسمّي مشروعك في كل توكن.
  • سر التوقيع (JWT)jwt_secret
    يوقّع به سيرفرك توكنات الناس.
  • مفتاح APIapi_key
    يصل مع الإشعارات ونداءات البحث إلى سيرفرك لتتحقق منه.
  • سر الإشعاراتwebhook_secret
    تتحقق به من توقيع كل إشعار (X-Webhook-Signature).

تظهر المفاتيح مرة واحدة عند إضافة الخدمة إلى المشروع، وتجدها بعد ذلك داخل الخدمة في إعدادات المشروع.

توكن الشخص

سيرفرك يوقّع توكن 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' })
}

تطبيقك وموقعك

  1. اطلب التوكن من سيرفرك

    للعميل المسجّل. لا تضع سر التوقيع في التطبيق.

  2. المقترحات

    كلها بالترويسة 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رفع مرفق.