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

צומת api

צומת זה מאפשר אינטראקציה עם APIs שונים, מה שיכול להיות מועיל לשילוב עם שירותים חיצוניים.

הגדרות צומת API​

IMG2

1. שם​

שדה לציון שם הצומת.
השם מוצג באזור העבודה ועוזר לזהות בקלות את הצומת.
אם תעזוב ריק, הצומת יקרא API.

דוגמה:

  • שם הצומת: Create Payment Session

2. שיטה​

כאן בוחרים את שיטת ה-API שתשמש לשליחת הבקשה. השיטות הזמינות:

  • "Create Payment Session" (יצירת סשן תשלום):
    יוצר סשן תשלום חדש.

  • "Update Payment Session" (עדכון סשן תשלום):
    מעדכן סשן תשלום קיים.

  • "Get Payment Session by ID" (קבלת סשן תשלום לפי ID):
    מקבל מידע על סשן תשלום לפי מזהה ייחודי של הסשן.

  • "Get Payment Session by Order ID" (קבלת סשן תשלום לפי Order ID):
    מקבל מידע על סשן תשלום, תוך שימוש במזהה ההזמנה.

דוגמה:

  • שיטה: Create Payment Session

3. נתונים​

שדה זה משתמש בתבנית Mustache ליצירת נתוני הבקשה בפורמט JSON.
אתה יכול להשתמש בנתונים מההודעה msg כדי להכניס ערכים לתבנית.

דוגמת תבנית (לשיטה "Create Payment Session"):

 {
   "orderId": {{orderId}},
   "type": "session"
 }

בדוגמה זו הערך orderId יוכנס מההודעה msg.

דוגמת תבנית (לשיטה "Update Payment Session"):

 {
   "id": {{paymentSessionId}},
   "paymentUrl": "{{{payload.links.1.href}}}"
 }

כאשר משתמשים בתבניות Mustache ניתן להעביר נתונים מורכבים ופרמטרים הנדרשים לאינטראקציה עם ה-API.

דוגמאות לבקשות​

דוגמה 1: יצירת סשן תשלום​

הגדרות הצומת:

  • שיטה (Method): Create Payment Session
  • נתונים (Data): 
    {
      "orderId": {{orderId}},
      "type": "session"
    }

הודעה:

{
  "orderId": 123
}

תוצאה:
הצומת ישלח בקשה ליצירת סשן תשלום עם הנתונים מההודעה. כתוצאה מכך יתקבל מידע על סשן תשלום חדש.

דוגמה 2: עדכון סשן תשלום​

הגדרות הצומת:

  • שיטה (Method): Update Payment Session
  • נתונים (Data): 
    {
      "id": {{paymentSessionId}},
      "paymentUrl": "{{{payload.links.1.href}}}"
    }

הודעה:

{
  "paymentSessionId": 123,
  "payload": {
    "id": "8YP51523N05861826",
    ....
    "links": [
      {
        "href": "https://api.sandbox.paypal.com/v2/checkout/orders/8YP51523N05861826",
        "rel": "self",
        "method": "GET"
      },
      {
        "href": "https://www.sandbox.paypal.com/checkoutnow?token=8YP51523N05861826",
        "rel": "payer-action",
        "method": "GET"
      }
    ]
  }
}

תוצאה:
הצומת ישלח בקשה לעדכון מצב סשן התשלום, תוך שימוש בערכים שסופקו payment_session_id ו-status.

דוגמה 3: קבלת סשן תשלום לפי ID​

הגדרות הצומת:

  • שיטה (Method): Get Payment Session by ID
  • נתונים (Data): 
    {
      "id": "{{paymentSessionId}}"
    }

הודעה:

{
  "paymentSessionId": 123
}

תוצאה:
הצומת ישלח בקשה לקבלת מידע על סשן תשלום לפי מזהה ייחודי של הסשן.

דוגמה 4: קבלת סשן תשלום לפי Order ID​

הגדרות הצומת:

  • שיטה (Method): Get Payment Session by Order ID
  • נתונים (Data): 
    {
      "orderId": "{{payload.id}}"
    }

הודעה:

{
  "payload": {
    "id": 1
  }
}

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