Method: echo

Gibt einen vom Client gesendeten String zurück.

Wenn am Endpunkt bei der Verarbeitung der Anfrage ein Fehler auftritt, hat dieser Endpunkt eine Antwort vom Typ ErrorResponse.

Die Antworten auf diese Abfrage können leer sein, wenn diese Methode keinen HTTP 200-Fehler zurückgibt. Der Antworttext ist leer, wenn ein ErrorResponse mit einer eindeutigen Beschreibung verwendet werden könnte, um einem Angreifer zu helfen, die Konto-ID des Zahlungsintegrators anderer Integratoren zu verstehen. In Fällen, in denen der Signaturschlüssel nicht übereinstimmt, die Zahlungsintegrator-ID nicht gefunden oder der Verschlüsselungsschlüssel unbekannt war, gibt diese Methode einen HTTP 404-Fehler mit leerem Text zurück. Wenn die Anfragesignatur verifiziert werden konnte, werden im Antworttext zusätzliche Informationen zum Fehler zurückgegeben.

Eine Beispielanfrage sieht so aus:


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

Ein Beispiel für eine erfolgreiche Antwort sieht so aus:


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

HTTP-Anfrage

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

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "clientMessage": string
}
Felder
requestHeader

object (RequestHeader)

ERFORDERLICH: Allgemeiner Header für alle Anfragen.
clientMessage

string

REQUIRED: Nachricht, die in der Antwort wiederholt werden soll.

Antworttext

Antwortobjekt für die echo-Methode.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "clientMessage": string,
  "serverMessage": string
}
Felder
responseHeader

object (ResponseHeader)

REQUIRED: Allgemeiner Header für alle Antworten.
clientMessage

string

REQUIRED: In der Anfrage erhaltene Nachricht.
serverMessage

string

OPTIONAL: Servernachricht, unabhängig vom clientMessage, das wiedergegeben wird.

RequestHeader

Header-Objekt, das für alle an den Server gesendeten Anfragen definiert wird.

JSON-Darstellung 
{
  "requestId": string,
  "requestTimestamp": {
    object (Timestamp)
  },
  "protocolVersion": {
    object (Version)
  },
  "paymentIntegratorAccountId": string
}
Felder
requestId

string

REQUIRED: Die eindeutige ID der Anfrage.

Dies ist ein String mit maximal 100 Zeichen, der nur die Zeichen „a–z“, „A–Z“, „0–9“, ":", „-“ und „_“ enthält.
requestTimestamp

object (Timestamp)

REQUIRED: Zeitstempel dieser Anfrage. Der Empfänger muss überprüfen, ob dieser Zeitstempel ± 60 Sekunden von „jetzt“ ist. Ist dies nicht der Fall, lehnt er die Anfrage ab. Dieser Anfragezeitstempel ist bei Wiederholungen nicht idempotent.
protocolVersion

object (Version)

REQUIRED: Die Version dieser Anfrage.
paymentIntegratorAccountId

string

ERFORDERLICH: Bezeichnet ein eindeutiges Konto mit vertraglichen Einschränkungen.