מבוא
ברוכים הבאים לתיעוד המפתחים ולמדריך ה-API של Rulrr.
לפני שמתחילים
אם עדיין לא עשיתם זאת, שלחו את טופס הבקשה כדי להפוך לשותף משולב רשמי של Rulrr והתחילו להציע ללקוחותיכם את היתרונות של פרסום דיגיטלי אוטומטי. הבקשות נבדקות בתוך עד 7 ימי עסקים, ובמקרה של אישור תקבלו מזהה לקוח (client ID) וסוד לקוח (client secret) ייחודיים, הנדרשים ליצירה מוצלחת של כל סוג של בקשה.
ה-API של Rulrr מאפשר את האינטגרציה של מערכות נקודת מכירה (POS) שונות עם מנוע השיווק האוטומטי של Rulrr. באמצעות חיבור ה-POS שלהם ל-Rulrr, בעלי חנויות יכולים ליצור קמפיינים פרסומיים ממוקדים לבסיס הלקוחות הספציפי שלהם ולמדוד את האפקטיביות של קמפיינים אלה.
חוויית המשתמש
תהליך מסע המשתמש כולל את השלבים הבאים:
- המשתמש מתחיל את תהליך האינטגרציה באפליקציית Rulrr על ידי בחירת אפליקציית לקוח שמשתלבת עם תהליך ה-oAuth של Rulrr. (יצירת קמפיין > אינטגרציית POS)
- האפליקציה תציג הוראות לביצוע בצד אפליקציית הלקוח.
- המשתמש מבצע את ההוראות ומפעיל את תכונת Rulrr-Connect באפליקציית הלקוח שלו.
תהליך ה-OAuth
תהליך האינטגרציה כולל את השלבים הבאים:
- ה-POS מבקש את אסימון האינטגרציה (Integration Token) תוך העברת מזהה הלקוח (client ID) וסוד הלקוח (client secret) (שסופקו על ידי Rulrr) בפרמטרים. Rulrr יוצר ישות אינטגרציה במסד הנתונים עם אסימון זה ובסטטוס "pending", ומחזיר אסימון גישה ל-POS.
- ה-POS שולח בקשה תקופתית הבודקת את סטטוס האינטגרציה, תוך העברת מזהה הלקוח (client ID), סוד הלקוח (client Secret) ואסימון האינטגרציה בפרמטרים. ממתין לסטטוס
finishedכדי לאחזר את אסימון הגישה. - ה-POS מציג IFrame עם האתר connect.rulrr.com. הוא חייב להכיל:
- integration_token המועבר כפרמטר
- client_id המועבר כפרמטר
- המשתמש משלים את טופס אימות החשבון והעדפות האינטגרציה ב-IFrame, ועם השלמתו, סטטוס האינטגרציה אמור להשתנות ל-'finished'.
- ה-POS מזהה שינוי בסטטוס (באמצעות בקשה תקופתית) ושולח בקשה לאחזור אסימוני הגישה והרענון שנוצרו. נקודת קצה זו תחזיר אסימונים פעם אחת בלבד!
- לאחר מכן יש לאפליקציית הלקוח גישה לנקודות הקצה הבאות: עדכון פרופיל החנות, שליחת רשימת לקוחות ושליחת הזמנה בודדת.
דרישות ומגבלות
- קודי ההרשאה המוחזרים על ידי דף האינטרנט של כתובת ההרשאה פגים לאחר 15 דקות. ניתן להשתמש בקוד הרשאה פעם אחת בלבד.
- אסימוני הגישה פגים לאחר 365 ימים. כדי לשמור על הגישה, עליכם ליצור אסימון גישה חדש באמצעות אסימון הרענון שהתקבל עם ההרשאה המקורית.
- אסימוני רענון שהתקבלו באמצעות תהליך הקוד אינם פגים. אם אבד לכם אסימון רענון, עליכם לחזור על תהליך ההרשאה המלא כדי לקבל אסימון גישה ואסימון רענון חדשים. אסימון רענון הופך ללא תקף רק כאשר הגישה של אפליקציית הלקוח בוטלה לחלוטין.