cadastro-lojas-ws-token

El consumo del servicio de generación de token es obligatorio para crear o editar una tienda. Como resultado de esta operación, el comerciante obtendrá un token por su URL de autenticidad que será necesario para el siguiente paso del flujo.

Detalles de la llamada#

  • Recurso : / v1 / token /merchants
  • Método HTTP : POST
  • Formato de respuesta : JSON
  • Parámetros de encabezado :
ParámetroDescripciónFormatoObligatorio
merchant_idCódigo de la tienda en el Portal Carat. Los códigos de producción y certificación serán diferentes. < 15 ANSI
merchant_keyClave de autenticación para la tienda de pagos online. Las claves de producción y certificación serán diferentes. < 80 ANSI

Ejemplo#

Solicitud:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/token/merchants"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--verbose

POST de autenticidad:

curl -X POST \
https://urlDeAutenticidadeDaLoja.com.br \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'cache-control: no-cache' \
-d 'token=1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr

Respuesta:

{
"response_code":0,
"response_message":"OK. Transaction successful."
}

Códigos de respuesta

Ver referencia en Códigos API - Códigos de respuesta

Parámetros POST de autenticidad#

En la siguiente tabla, hay una descripción de los parámetros enviados por Portal Carat en el POST de autenticidad:

ParámetroDescripciónFormato
tokenToken que se utilizará en el siguiente paso del flujo.= 66 AN

Lo Portal Carat también puede enviar nuevos parámetros sin previo aviso, lo que significa que la solicitud del comerciante debe estar preparada para recibir campos adicionales y simplemente ignorarlos.

Atención: Es esencial que el sitio alojado en la URL de autenticidad de la tienda reciba el token de autenticidad y responda "HTTP 200", ya que esta es una condición para que Portal Carat considere el éxito de este POST.

Parámetros de respuesta#

Si tiene éxito, el código de respuesta HTTP será "200". Cualquier otro código debe interpretarse como un error. En la siguiente tabla se muestra la descripción de los parámetros de respuesta del servicio de creación de tokens:

ParámetroDescripciónFormato
response_codeCódigo de respuesta de Portal Carat. Cualquier código que no sea "0" (cero) significa falla. [Más información.] (codigos-da-api.md#codigos-de-resposta) < 4 N
response_messageMensaje de respuesta de Portal Carat.< 500 AN