تخطّ إلى المحتوى الرئيسي

نظرة عامة للمطورين

مرحبًا بكم في توثيق مطوري Joryio. يساعدكم هذا الدليل على دمج Joryio في تطبيقاتكم.

ماذا يمكنكم بناءه؟​

مع منصة المطورين من Joryio، يمكنكم:

  • تتبع سلوك المستخدمين عبر الويب وiOS وAndroid
  • إدارة ملفات المستخدمين وسماتهم برمجيًا
  • إرسال أحداث مخصصة لتشغيل التقسيم والتحليلات
  • التكامل مع webhooks لإشعارات الأحداث في الوقت الحقيقي
  • تشغيل الحملات عبر API
  • استعلام بيانات التحليلات للوحات معلومات مخصصة

بنية المنصة​

Data in
Your appsSDK keys
Web · iOS · Android · React Native
Your backendAPI keys
REST API
Store platforms
Shopify · WooCommerce · Magento
Bulk import
CSV · JSON
Warehouse sync
Snowflake · BigQuery
Joryio platform
Joryio
Profiles & events
Segments
Journeys (Canvas)
Campaigns
Analytics & ML
Data out
Messages
Email · SMS · WhatsApp · Push · In-app · Wallet
Webhooks
journey nodes & event streams
Data streaming
Snowflake · BigQuery · Redshift · S3 · Kafka · Mixpanel · Amplitude

One track() call powers every surface — a Kafka-based streaming spine fans events out in real time.

تتفرع الأحداث إلى التحليلات واستهداف الجمهور وإشارات مكافأة ML وتقييم محفزات الرحلة لحظة وصولها. ويغذي العمود الفقري نفسه بث البيانات، الذي يوصل أحداثكم إلى مستودعكم أو تخزينكم أو مكدس التحليلات لديكم، وتجلب مزامنة المستودع بياناتكم الموجودة إلى الداخل.

المصادقة​

يستخدم Joryio نوعين من المصادقة:

مفاتيح SDK (من جانب العميل)​

لتتبع تطبيقات الويب والجوال:

jry_sdk_web_abc123...     (Web SDK)
jry_sdk_ios_def456...     (iOS SDK)
jry_sdk_android_ghi789... (Android SDK)

الأمان: آمنة للإدراج في كود العميل. تقتصر على عمليات التتبع فقط.

مفاتيح API (من جانب الخادم)​

لاستدعاءات API بين الخوادم:

jry_live_xyz789... (الإنتاج)
jry_test_abc123... (الاختبار)

الأمان: يجب أن تبقى سرية. لا تكشفوها أبدًا في كود العميل. تملك وصولًا كاملًا لكل عمليات API.

حافظوا على سرية مفاتيح API

لا تلتزموا بمفاتيح API في التحكم بالإصدارات ولا تكشفوها في كود العميل. استخدموا متغيرات البيئة.

دمج سريع​

1. تتبع الويب​

import JoryioSDK from '@joryio/web-sdk';

const joryio = new JoryioSDK({
  sdkKey: 'jry_sdk_web_your_key_here'
});

// تعريف مستخدم
joryio.identify('user_123');
joryio.setAttributes({
  email: 'user@example.com',
  plan: 'premium',
});

// تتبع حدث
joryio.track('Button Clicked', {
  button: 'signup',
  page: 'homepage'
});

2. API من جانب الخادم​

const response = await fetch('https://api-eu1.joryio.com/users', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer jry_live_your_api_key_here'
  },
  body: JSON.stringify({
    userId: 'user_123',
    email: 'user@example.com',
    attributes: {
      plan: 'premium',
      signupDate: '2024-01-15'
    }
  })
});

حزم SDK والمكتبات​

حزم SDK الرسمية​

المنصةالحالةالتوثيق
الويب (JavaScript)متاحدليل Web SDK
iOS (Swift)متاحدليل iOS SDK
Android (Kotlin)متاحدليل Android SDK
React Nativeمتاحدليل React Native SDK

REST API​

REST API كامل لكل العمليات:

  • مرجع API
  • رابط الأساس: https://api-eu1.joryio.com
  • التنسيق: JSON
  • المصادقة: مفتاح API من نوع bearer (Authorization: Bearer jry_live_...)

مفاهيم أساسية​

لكل مفهوم دليل خاص به - هذه الصفحة تبقى خريطة:

  • التطبيقات - واحد لكل منصة، ولكل واحد مفتاح SDK خاص به.
  • المستخدمون - الملفات والسمات والأسماء البديلة وAPI الإنشاء/التحديث.
  • الأحداث - اتفاقيات التسمية والخصائص وidentify مقابل track والتصحيح.
  • الشرائح - مجموعات مستخدمين ديناميكية حسب السمات والسلوك.

سير عمل التطوير​

1. بيئة التطوير​

# استخدموا مفاتيح API الاختبارية
export JORYIO_API_KEY=jry_test_abc123...

فعّلوا وضع التصحيح في Web SDK:

const joryio = new JoryioSDK({
  sdkKey: 'jry_sdk_web_test_...',
  enableDebug: true
});

2. الاختبار​

  • استخدموا مفاتيح API الاختبارية للتطوير
  • أنشئوا شرائح وحملات اختبارية
  • تحققوا من الأحداث في لوحة المعلومات
  • اختبروا نقاط نهاية webhook محليًا (باستخدام ngrok)

3. النشر للإنتاج​

  • انتقلوا إلى مفاتيح API الإنتاجية
  • عطّلوا وضع التصحيح
  • راقبوا معدلات الأخطاء
  • أعدوا webhooks للأحداث الحرجة

حدود المعدل والأخطاء​

سلوك حدود المعدل (429 + Retry-After) ونص الخطأ القياسي ورموز الحالة موثقة مرة واحدة في نظرة API العامة: حدود المعدل · رموز HTTP للحالة.

إخراج الأحداث​

لتلقي أحداث Joryio على نقطة النهاية الخاصة بكم في الوقت الحقيقي، أضيفوا وجهة Webhook في بث البيانات - يُرسل كل حدث كـPOST بصيغة JSON إلى رابط HTTPS الخاص بكم. تستطيع الرحلات أيضًا استدعاء أنظمتكم لكل جهة اتصال بعقدة Webhook، ويمكن فحص عمليات تسليم webhook الفاشلة وإعادة محاولتها في الإعدادات ← السجلات والمراقبة (إعادات Webhook).

أفضل الممارسات​

  • تسمية الأحداث - Title Case، كائن + إجراء (Order Completed): راجعوا اتفاقيات التسمية.
  • التجميع والتسليم - تجمع حزم SDK الأحداث وتدفعها تلقائيًا (حتى 500 حدث في الدفعة)؛ راجعوا كيف يعمل التتبع.
  • عرّفوا مبكرًا، وأعيدوا الضبط عند تسجيل الخروج - راجعوا identify مقابل track.

الدعم والموارد​

الخطوات التالية​

  1. ادمجوا Web SDK
  2. أعدوا تتبع المستخدمين
  3. أنشئوا شريحتكم الأولى
  4. أرسلوا حملة