מדריך למפתחים

OAuth

אחזור אסימוני גישה ורענון

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

זהו התהליך שבו אפליקציות לקוח מקבלות קוד אינטגרציה הנפדה לקבלת אסימון גישה ואסימון רענון. אסימונים אלה מאפשרים לנהל משאבים של חשבון Rulrr ומשמשים בעת קריאה ל-API של Rulrr.

שלב 1 | יצירת קוד האינטגרציה

POST /v1/auth/integration?client_id=<clientId>&client_secret=<clientSecret>

יוצר את קוד האינטגרציה. דורש client_id כדי לזהות את סוג ה-POS.

פרמטרים

  • client_id — מזהה שסופק על ידי Rulrr לכל ספק. הוא מזהה את ה-POS שמנסה להשתלב.
  • client_secret — אסימון סודי שסופק על ידי Rulrr לכל ספק. מאפשר לזהות אם הלקוח נכון.

תגובת JSON

{
  "success": true,
  "integrationToken": <token>
}

או 400 אם מזהה הלקוח שגוי או 403 אם סוד הלקוח שגוי.

שלב 2 | בדיקת סטטוס האינטגרציה

GET /v1/auth/integration?client_id=<client_id>&client_secret=<client_secret>&integration_token=<integrationToken>

מחזיר את סטטוס האינטגרציה.

פרמטרים

  • integration_token — אסימון שנוצר בנקודת הקצה POST /v1/auth/integration.
  • client_secret — ה-POS צריך לשלוח גם סוד זה כדי לוודא שהבקשה תקפה ושאסימון האינטגרציה לא נחשף בשום מקום.
  • client_id — כדי לזהות את ה-POS.

תגובת JSON

{
  "success": true,
  "status": 'pending' | 'finished' | 'cancelled'
}

או 403 אם אסימון האינטגרציה או סוד הלקוח שגויים.

שלב 3 | הצגת ה-IFrame של Rulrr-Connect

ה-POS מציג IFrame עם האתר connect.rulrr.com.

כתובת ה-URL חייבת להכיל:

  • integration_token המועבר כפרמטר
  • client_id המועבר כפרמטר

המשתמש מבצע שם את האינטגרציה, ועם השלמתה, סטטוס האינטגרציה אמור להשתנות ל-'finished'.

מסך ההתחברות של ה-IFrame של Rulrr-Connect ב-connect.rulrr.com

שלב 4 | קבלת אסימון הגישה והרענון

יש להשתמש רק כאשר סטטוס האינטגרציה הוא finished כדי לאחזר את אסימוני הגישה והרענון.

GET /v1/auth/integration/token?client_id=<client_id>&client_secret=<client_secret>&integration_token=<integrationToken>

החזרה חד-פעמית של אסימוני הגישה והרענון שנוצרו בסוף תהליך האינטגרציה.

פרמטרים

  • integration_token — אסימון שנוצר בנקודת הקצה POST /v1/auth/integration.
  • client_secret — ה-POS צריך לשלוח גם סוד זה כדי לוודא שהבקשה תקפה ושאסימון האינטגרציה לא נחשף בשום מקום.
  • client_id — כדי לזהות את ה-POS.

תגובת JSON

{
  "success": true,
  "accessToken": <accessToken>,
  "refreshToken": <refreshToken>,
  "expiration": <expirationDate>,
  "ereceipt": true,
}

או 403 אם אסימון האינטגרציה שגוי או 410 אם האסימון כבר אוחזר עם מפתחות אלה.

תוכלו להפעיל את נקודות הקצה הבאות: עדכון פרופיל החנות, שליחת רשימת לקוחות ושליחת הזמנה בודדת.

שלב 5 | הצגת לוח מקשים מספרי בכל הזמנה

יש לבצע רק כאשר פרמטר ה-e-receipt מוגדר כ-true.

ה-POS מציג לוח מקשים מספרי המאפשר למשתמש לשלוח קבלות אלקטרוניות בהודעת טקסט.

במקרה שהמשתמש מחליט לשלוח קבלה אלקטרונית ומזין מספר טלפון תקף, בטלו את הקבלה המודפסת.

לוח מקשים מספרי להפעלת קבלה אלקטרונית במסוף ה-POS