Method: echo

क्लाइंट से भेजी गई स्ट्रिंग को फिर से इको करता है.

अगर अनुरोध को प्रोसेस करते समय एंडपॉइंट किसी गड़बड़ी का सामना करता है, तो इस एंडपॉइंट से मिलने वाले रिस्पॉन्स का मुख्य हिस्सा ErrorResponse का होना चाहिए.

अनुरोध का एक उदाहरण ऐसा दिखता है:


{
  "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"
}

एचटीटीपी अनुरोध

POST https://www.integratorhost.example.com/v2/echo

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में इस तरह का डेटा शामिल होता है:

जेएसओएन के काेड में दिखाना
{
  "requestHeader": {
    object (RequestHeader)
  },
  "clientMessage": string
}
फ़ील्ड
requestHeader

object (RequestHeader)

ज़रूरी: सभी अनुरोधों के लिए सामान्य हेडर.

clientMessage

string

ज़रूरी: जवाब में इको होने वाला मैसेज.

जवाब का मुख्य भाग

इको तरीके के लिए रिस्पॉन्स ऑब्जेक्ट.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "clientMessage": string,
  "serverMessage": string
}
फ़ील्ड
responseHeader

object (ResponseHeader)

ज़रूरी: सभी जवाबों के लिए सामान्य हेडर.

clientMessage

string

ज़रूरी: अनुरोध में मैसेज मिला.

serverMessage

string

ज़रूरी नहीं: सर्वर का मैसेज, clientMessage से अलग, इको हो रहा है.

RequestHeader

हेडर ऑब्जेक्ट, जो सर्वर को भेजे गए सभी अनुरोधों पर तय होता है.

जेएसओएन के काेड में दिखाना
{
  "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

ज़रूरी है: अनुबंध की शर्तों वाले यूनीक खाते की पहचान करता है.