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 ( |
Pola | |
---|---|
requestHeader |
REQUIRED: wspólny nagłówek dla wszystkich żądań. |
clientMessage |
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 ( |
Pola | |
---|---|
responseHeader |
REQUIRED: wspólny nagłówek wszystkich odpowiedzi. |
clientMessage |
REQUIRED: w żądaniu odebrano wiadomość. |
serverMessage |
OPCJONALNIE: komunikat serwera niezależnie od odczytywanego parametru |
RequestHeader
Obiekt nagłówka zdefiniowany we wszystkich żądaniach wysyłanych do serwera.
Zapis JSON |
---|
{ "requestId": string, "requestTimestamp": { object ( |
Pola | |
---|---|
requestId |
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 |
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 |
REQUIRED: wersja żądania. |
paymentIntegratorAccountId |
REQUIRED: identyfikuje unikalne konto z ograniczeniami umownymi. |