Method: echo

Zwraca na serwer ciąg znaków wysłany przez klienta.

Jeśli podczas przetwarzania żądania punkt końcowy napotka błąd, treść odpowiedzi z tego punktu końcowego powinna być typu ErrorResponse.

Przykładowe żądanie wygląda tak:


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

Przykładowa odpowiedź o powodzeniu wygląda tak:


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

Żądanie HTTP

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

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "clientMessage": string
}
Pola
requestHeader

object (RequestHeader)

REQUIRED: wspólny nagłówek dla wszystkich żądań.
clientMessage

string

REQUIRED: wiadomość do wykonania w odpowiedzi.

Treść odpowiedzi

Obiekt odpowiedzi dla metody echa.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "clientMessage": string,
  "serverMessage": string
}
Pola
responseHeader

object (ResponseHeader)

REQUIRED: wspólny nagłówek wszystkich odpowiedzi.
clientMessage

string

REQUIRED: w żądaniu odebrano wiadomość.
serverMessage

string

OPCJONALNIE: komunikat serwera niezależnie od odczytywanego parametru clientMessage.

RequestHeader

Obiekt nagłówka zdefiniowany we wszystkich żądaniach wysyłanych do serwera.

Zapis JSON 
{
  "requestId": string,
  "requestTimestamp": {
    object (Timestamp)
  },
  "protocolVersion": {
    object (Version)
  },
  "paymentIntegratorAccountId": string
}
Pola
requestId

string

REQUIRED: unikalny identyfikator tego żądania.

Jest to ciąg o maksymalnej długości 100 znaków, który zawiera tylko znaki „a–z”, „A–Z”, „0–9”, „:”, „-” i „_”.
requestTimestamp

object (Timestamp)

REQUIRED: sygnatura czasowa żądania. Odbiorca musi sprawdzić, czy sygnatura czasowa to ± 60 s „teraz” i odrzucić żądanie, jeśli nie jest. Ta sygnatura czasowa żądania nie jest idempotentna przy ponownych próbach.
protocolVersion

object (Version)

REQUIRED: wersja żądania.
paymentIntegratorAccountId

string

REQUIRED: identyfikuje unikalne konto z ograniczeniami umownymi.