انتقل إلى المحتوى

واجهة API للمكافآت: اربطها بأنظمتك.

14 نقطة اتصال في واجهة API للشركاء و6 أنواع من أحداث Webhooks الموقّعة تتيح لك تسجيل الأعضاء وإضافة الرصيد والتحويل والاستبدال وإعداد التقارير من أنظمتك.

نقطة اتصال في واجهة API للشركاء

أنواع أحداث Webhooks

محاولات إعادة لكل Webhook

مهام مجدولة ليلية

خمسة أشياء يستطيع نظامك القيام بها.

نقاط الاتصال مجمّعة حسب وظيفتها، ليبدو الربط وكأنه جزء من منتجك.

  • التسجيل

    أنشئ الأعضاء دفعة واحدة أو واحدًا تلو الآخر من نظام الموارد البشرية أو تخطيط الموارد أو الولاء لديك.

  • إضافة الرصيد

    أضف النقاط أو القيمة إلى سجل غير قابل للتعديل ومحصَّن ضد التكرار.

  • التحويل

    حوّل النقاط من برنامجك إلى قيمة قابلة للاستبدال فورًا.

  • الاستبدال

    أصدر القسائم وبطاقات الهدايا، واحجز عمليات الاستبدال أو نفّذها أو ألغِها مع حجز المخزون.

  • التقارير

    استخرج تقارير الاستبدال والإنفاق والكتالوج، أو صدّرها بصيغة CSV.

ستة أنواع من الأحداث الموقّعة.

تلقَّ إشعارًا عند إصدار المكافآت وإضافة النقاط واستبدال القسائم، ليبقى نظامك متطابقًا دائمًا مع كمان.

  • موقّعة بـ HMAC

    كل حدث موقّع لتتحقق من أنه صادر من كمان.

  • إعادة المحاولة 3 مرات

    يُعاد إرسال الأحداث التي فشل تسليمها تلقائيًا.

  • حدود طلبات لكل مفتاح

    تُطبَّق الحدود على كل مفتاح API، فلا يستنزف أي ربط تقني موارد ربط آخر.

  • حماية من هجمات التخمين

    حدود طلبات حسب عنوان IP على كل عملية استبدال.

verify-webhook.ts
1import crypto from "node:crypto";2 3// Verify a Kaman webhook before trusting it.4// See the API reference for the exact header.5export function isFromKaman(6  body: string,7  signature: string,8  secret: string,9) {10  const expected = crypto11    .createHmac("sha256", secret)12    .update(body)13    .digest("hex");14 15  return crypto.timingSafeEqual(16    Buffer.from(expected),17    Buffer.from(signature),18  );19}
TypeScript · Node.jsللتوضيح

مفاتيح بيئة تجريبية من اليوم الأول.

مفاتيح API تحمل علامتك ويمكن إلغاؤها، وبيئة تجريبية مشمولة في كل اشتراك. ابنِ الربط واختبره قبل إصدار أي مكافأة حقيقية.

اطلب الوصول إلى واجهة API