Method: echo

Elle renvoie une chaîne envoyée par le client.

Si le point de terminaison rencontre une erreur lors du traitement de la requête, la réponse de ce point de terminaison sera de type ErrorResponse.

Les réponses à cette requête peuvent être vides si cette méthode ne renvoie pas de code HTTP 200. Le corps de la réponse est vide dans les cas où un ErrorResponse avec une description claire pourrait être utilisé pour aider un pirate informatique à comprendre l'identifiant de compte d'intégrateur de paiement d'autres intégrateurs. Dans les cas où la clé de signature ne correspond pas, que l'identifiant de l'intégrateur de paiement est introuvable ou que la clé de chiffrement est inconnue, cette méthode renvoie une réponse HTTP 404 avec un corps vide. Si la signature de la requête a pu être vérifiée, des informations supplémentaires sur l'erreur sont renvoyées dans le corps de la réponse.

Voici un exemple de requête:


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

Voici un exemple de réponse positive:


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

Requête HTTP

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

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "clientMessage": string
}
Champs
requestHeader

object (RequestHeader)

OBLIGATOIRE: en-tête commun pour toutes les requêtes.
clientMessage

string

OBLIGATOIRE: message à renvoyer dans la réponse.

Corps de la réponse

Objet réponse pour la méthode echo.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "clientMessage": string,
  "serverMessage": string
}
Champs
responseHeader

object (ResponseHeader)

OBLIGATOIRE: en-tête commun pour toutes les réponses.
clientMessage

string

OBLIGATOIRE: message reçu dans la requête.
serverMessage

string

FACULTATIF: message du serveur, indépendant du clientMessage en cours d'écho.

RequestHeader

Objet d'en-tête qui est défini sur toutes les requêtes envoyées au serveur.

Représentation JSON 
{
  "requestId": string,
  "requestTimestamp": {
    object (Timestamp)
  },
  "protocolVersion": {
    object (Version)
  },
  "paymentIntegratorAccountId": string
}
Champs
requestId

string

OBLIGATOIRE: Identifiant unique de cette requête.

Il s'agit d'une chaîne d'une longueur maximale de 100 caractères, qui ne contient que les caractères "a-z", "A-Z", "0-9", ":", "-" et "_".
requestTimestamp

object (Timestamp)

OBLIGATOIRE: horodatage de cette requête. Le destinataire doit vérifier que ce code temporel est à ± 60 secondes de "now" et refuser la requête dans le cas contraire. Cet horodatage de requête n'est pas idempotent lors de nouvelles tentatives.
protocolVersion

object (Version)

OBLIGATOIRE: version de cette requête.
paymentIntegratorAccountId

string

OBLIGATOIRE: identifie un compte unique soumis à des contraintes contractuelles.