דלג לתוכן הראשי

סקירה למפתחים

ברוכים הבאים לתיעוד המפתחים של Joryio. מדריך זה יעזור לכם לשלב את Joryio באפליקציות שלכם.

מה אפשר לבנות?​

עם פלטפורמת המפתחים של Joryio תוכלו:

  • לעקוב אחרי התנהגות משתמשים בווב, iOS ואנדרואיד
  • לנהל פרופילי משתמשים ומאפיינים בצורה תכנותית
  • לשלוח אירועים מותאמים עבור סגמנטציה וניתוחים
  • להשתלב עם Webhooks לקבלת התראות בזמן אמת
  • להפעיל קמפיינים דרך API
  • לבצע שאילתות על נתוני אנליטיקה עבור לוחות בקרה מותאמים

ארכיטקטורת הפלטפורמה​

נתונים נכנסים
האפליקציות שלכםSDK keys
Web · iOS · Android · React Native
צד השרת שלכםAPI keys
REST API
פלטפורמות חנות
Shopify · WooCommerce · Magento
ייבוא מרוכז
CSV · JSON
סנכרון מחסן נתונים
Snowflake · BigQuery
פלטפורמת Joryio
Joryio
פרופילים ואירועים
סגמנטים
מסעות (Canvas)
קמפיינים
אנליטיקה ו-ML
נתונים יוצאים
הודעות
אימייל · SMS · WhatsApp · Push · In-app · Wallet
Webhooks
צמתי מסע וזרמי אירועים
הזרמת נתונים
Snowflake · BigQuery · Redshift · S3 · Kafka · Mixpanel · Amplitude

קריאת track() אחת מפעילה את כל השכבות — תשתית הזרמה מבוססת Kafka מפיצה את האירועים בזמן אמת.

האירועים מופצים אל מערכות האנליטיקה, מיקוד הקהלים, אותות ה-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... (Production)
jry_test_abc123... (Testing)

אבטחה: חייבים להישאר חסויים. אין לחשוף בקוד בצד הלקוח. גישה מלאה לכל פעולות ה־API.

שמרו על מפתחות API בסוד

אל תכניסו מפתחות API לבקרת גרסאות ואל תחשפו אותם בקוד בצד הלקוח. השתמשו במשתני סביבה.

אינטגרציה מהירה​

1. מעקב ווב​

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

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

// Identify user
joryio.identify('user_123');
joryio.setAttributes({
  email: 'user@example.com',
  plan: 'premium',
});

// Track event
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'
    }
  })
});

SDKs וספריות​

SDKs רשמיים​

פלטפורמהסטטוסתיעוד
Web (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 משלה.
  • משתמשים - פרופילים, מאפיינים, כינויים (aliases) ו-API ליצירה/עדכון.
  • אירועים - מוסכמות שמות, מאפיינים, identify מול track ודיבוג.
  • סגמנטים - קבוצות משתמשים דינמיות לפי מאפיינים והתנהגות.

תהליך פיתוח​

1. סביבת פיתוח​

# Use test API keys
export JORYIO_API_KEY=jry_test_abc123...

הפעלת מצב debug ב-Web SDK:

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

2. בדיקות​

  • השתמשו במפתחות API לבדיקה
  • צרו סגמנטים וקמפיינים לבדיקות
  • ודאו שהאירועים מופיעים בלוח הבקרה
  • בדקו נקודות קצה של webhooks מקומית (השתמשו ב־ngrok)

3. פריסה לסביבת ייצור​

  • עברו למפתחות API של סביבת הייצור
  • השביתו מצב debug
  • עקבו אחרי שיעורי שגיאות
  • הגדירו webhooks עבור אירועים קריטיים

מגבלות קצב ושגיאות​

התנהגות מגבלות הקצב (‎429 + Retry-After), גוף השגיאה הסטנדרטי וקודי הסטטוס מתועדים פעם אחת, בסקירת ה-API: Rate Limiting · HTTP Status Codes.

הוצאת אירועים החוצה​

כדי לקבל אירועי Joryio בנקודת קצה משלכם בזמן אמת, הוסיפו יעד Webhook בסטרימינג נתונים - כל אירוע נשלח כ-JSON ב-POST לכתובת ה-HTTPS שלכם. מסעות יכולים גם לקרוא למערכות שלכם לכל איש קשר באמצעות צומת ה-Webhook, ומשלוחי webhook שנכשלו ניתנים לבדיקה ולניסיון חוזר ב-Settings → Logs & Monitoring (ניסיונות Webhook חוזרים).

שיטות עבודה מומלצות​

תמיכה ומשאבים​

צעדים הבאים​

  1. שלבו את Web SDK
  2. הגדירו מעקב משתמשים
  3. צרו את הסגמנט הראשון
  4. שלחו קמפיין