Method: echo

מחזיר הד למחרוזת שנשלחה מהלקוח.

אם נקודת הקצה נתקלת בשגיאה במהלך עיבוד הבקשה, התשובה מנקודת הקצה הזו תהיה מסוג ErrorResponse.

אם השיטה הזו לא מחזירה HTTP 200, התשובות לשאילתה הזו יכולות להיות ריקות. גוף התגובה הוא ריק במצבים שבהם ErrorResponse עם תיאור ברור יכול לעזור לתוקפים להבין את מזהה החשבון של מבצע השילוב של התשלומים של משלבים אחרים. במצבים כאלה, שבהם מפתח החתימה לא תואם, המזהה של משלב התשלומים לא נמצא או שמפתח ההצפנה לא היה ידוע, השיטה הזו תחזיר קוד HTTP 404 עם גוף ריק. אם ניתן לאמת את חתימת הבקשה, בגוף התגובה יוחזר מידע נוסף לגבי השגיאה.

בקשה לדוגמה נראית כך:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 2
    },
    "requestId": "G1MQ0YERJ0Q7LPM",
    "requestTimestamp": {
      "epochMillis": "1481899949606"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "clientMessage": "Client echo message"
}

דוגמה לתגובה להצלחה נראית כך:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis":"1481899950236"
    }
  },
  "clientMessage": "Client echo message",
  "serverMessage": "Debug ID 12345"
}

בקשת HTTP

POST https://vgw.googleapis.com/secure-serving/gsp/v2/echo/:PIAID

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "clientMessage": string
}
שדות
requestHeader

object (RequestHeader)

חובה: כותרת משותפת לכל הבקשות.
clientMessage

string

חובה: הודעה שתזכיר את התשובה שלה.

גוף התגובה

אובייקט תגובה לשיטת ההד.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "clientMessage": string,
  "serverMessage": string
}
שדות
responseHeader

object (ResponseHeader)

חובה: כותרת נפוצה לכל התשובות.
clientMessage

string

חובה: התקבלה הודעה בבקשה.
serverMessage

string

אופציונלי: הודעת שרת, ללא קשר ל-clientMessage שההד.

RequestHeader

אובייקט כותרת שמוגדר בכל הבקשות שנשלחות לשרת.

ייצוג JSON 
{
  "requestId": string,
  "requestTimestamp": {
    object (Timestamp)
  },
  "protocolVersion": {
    object (Version)
  },
  "paymentIntegratorAccountId": string
}
שדות
requestId

string

חובה: המזהה הייחודי של הבקשה.

זוהי מחרוזת באורך מקסימלי של 100 תווים והיא מכילה רק את התווים "a-z", "A-Z", "0-9", ":", "-" ו-"_".
requestTimestamp

object (Timestamp)

חובה: חותמת הזמן של הבקשה. המקבל חייב לוודא שחותמת הזמן הזו היא ± 60 שניות של 'עכשיו' ולדחות את הבקשה אם היא לא נכונה. חותמת הזמן של הבקשה אינה מזהה ביחס לניסיונות החוזרים.
protocolVersion

object (Version)

חובה: הגרסה של הבקשה.
paymentIntegratorAccountId

string

חובה: זיהוי חשבון ייחודי עם מגבלות חוזיות.