• Francia
Buscar
Categoria
Tags
Argentina
Argentina
Implementación
Formulario incrustado (tarjetas)
API REST
API REST PCI-DSS
Formulario en redirección
Intercambio de ficheros
Pago móvil
Ejemplo de código
Módulos de pago
Back office
Ayuda
FAQ
Contacto

Guía de integración (modo simple)

1. Añadir la biblioteca JavaScript a su sitio

Para facilitar la integración de la solución, nuestra biblioteca JavaScript recopila datos del equipo y el navegador del cliente, se comunica directamente con el servidor 3DS y gestiona la interacción del titular de la tarjeta durante el reto.

En el HEAD de la página se debe añadir la biblioteca JavaScript en una etiqueta <script>.

<head>
 ...
 <script src="https://static.cobroinmediato.tech/static/js/authenticate-client/V1.0/kr-authenticate.umd.js"></script>
 ...
</head>

2. Iniciar una solicitud de autentificación del titular

Appelez le service PCI/Authentication/CreateSession en utilisant les champs ci-dessous :

NIVEL APELLIDO Descripción OBLIGATORIO
1 customer Objeto que contiene los datos del comprador. NO
1 paymentForm Objeto que contiene los datos de la tarjeta. Sí
2 pan Número de tarjeta. Sí
2 expiryMonth Mes de caducidad de la tarjeta. Sí
2 expiryYear Año de caducidad de la tarjeta. Sí
2 networkPreference Nombre de la red preferida recomendada por el vendedor. Sí
1 vendedor Objeto que contiene el número de afiliación. Sí
2 mid Número de afiliación del vendedor. Sí
1 protocolRequest Objeto que describe el modo de autentificación deseado. Sí
2 name Nombre del protocolo de autentificación. Sí
2 VERSIÓN Versión del protocolo de autentificación. NO
1 vendedor Objeto que contiene los detalles del contrato. Sí
1 productType Tipo de producto correspondiente en la transacción. Sí
1 transactionCategory Valorizado a PAYMENT. Sí
1 amount Monto por el que se solicita la autentificación. Sí
1 ianTargetUrl URL obligatoria para la notificación de fin de autentificación Sí

Existen campos opcionales. Encuentre la descripción de los campos en nuestro Playground.

Se recomienda transmitir la mayor cantidad de datos posibles sobre el comprador a través del objeto customer para aumentar las posibilidades de obtener una autentificación frictionless.

Ejemplo de solicitud

/doc/es-AR/rest/V4.0/api/kb/authentication.html
https://github.com/lyra/rest-php-examples/blob/master/www/minimalEmbeddedForm.php#L9-L44
https://api.cobroinmediato.tech/api-payment/V4/PCI/Authentication/CreateSession
{
  "amount": 1230,
  "currency": "ARS",
  "transactionCategory": "PAYMENT",
  "productType": "GOODS_OR_SERVICE_PURCHASE",
  "merchant": {
    "mid": ""
  },
  "paymentForm":{
    "pan": "4970110000000013",
    "expiryMonth": "02",
    "expiryYear": "24",
    "networkPreference": "VISA"
  },
  "protocolRequest": {
    "name": "THREEDS",
    "version": "2",
    "challengePreference": "NO_PREFERENCE"
  },
  "ianTargetUrl": "https://myiantargeturl.com"
}
 
En el AuthenticationSessionResponse, encontrará los siguientes campos:
 
  • answer.operationSessionId: ID de la sesión de autentificación (para mantener)
    •  
  • answer.operationUrl: url para enviar a la biblioteca JavaScript
 
Encuentre la descripción de los campos en nuestro Playground.
 
Ejemplo de respuesta
 
{
  "webService":"PCI/Authentication/CreateSession",
  "version":"V4",
  "applicationVersion":"6.0.0",
  "serverDate":"2023-04-16T11:11:21+00:00",
  "ticket":"839ecda45f6449a8869747a80c26b2d2",
  "applicationProvider":"COIN",
  "metadata":null,
  "status":"SUCCESS",
  "mode":"TEST",
  "serverUrl":"https://api.cobroinmediato.tech",
  "_type":"V4/WebService/Response",
  "answer":{
    "operationSessionId":"30641640cba14eab8e6766094fd201da",
    "operationUrl":"https://api.cobroinmediato.tech/api-payment/V4/Charge/Public/Authenticate/Session/30641640cba14eab8e6766094fd201da;JSESSIONID=7A4beEA2d5fdbFeA7389F3B91a7bDBaBc8DA9df5.default-hostname",
    "_type":"V4/PCI/Authentication/AuthenticationSessionResponse"
  }
}
 
En el ejemplo:
 
  • answer.operationSessionId: "30641640cba14eab8e6766094fd201da"
    •  
  • answer.operationUrl: "https://api.cobroinmediato.tech/api-payment/V4/Charge/Public/Authenticate/Session/30641640cba14eab8e6766094fd201da;JSESSIONID=7A4beEA2d5fdbFeA7389F3B91a7bDBaBc8DA9df5.default-hostname"
 
3. Inicializar el script de autentificación
 
Una vez creada la sesión de autentificación, debe inicializar la biblioteca de autentificación JavaScript y luego llamar al método "Authenticate". Se recomienda agragar un indicador visual de carga durante la llamada.
 
// définition de la class javascript
class KrAuthenticate{
  constructor(publicKey,options)
  authenticate(operationUrl)
}
 
1. Parámetros de inicialización de la clase KrAuthenticate
 
APELLIDO Descripción OBLIGATORIO
 
publicKey Clave pública de test o de producción de la tienda. Más información: **3ª clave** de la tabla de claves de la API REST. Sí
 
options Elemento del DOM en el que se muestra la ventana de autentificación (opcional). NO
 
También puede mostrar la ventana de autentificación en otro elemento del DOM utilizando el atributo element del parámetro opcional options.
 
  • Sin el elemento DOM ( recomendado ) :
 
  const krAuthenticate = new KrAuthenticate("45789921:testpublickey_qSbs1nvRJEdy74KqANWo6TnGnRsTzwFMd9DYrO9OCdiHD");
 
  • Con el elemento DOM:
 
  const krAuthenticate = new KrAuthenticate("45789921:testpublickey_qSbs1nvRJEdy74KqANWo6TnGnRsTzwFMd9DYrO9OCdiHD", {
 element: document.getElementById("id-challenge-element")
  });
 
En este ejemplo, el id del elemento DOM es : id-challenge-element.
 
2. Parámetros del método de ejecución de la autentificación KrAuthenticate.authenticate
 
Utilisez le champ operationUrl généré lors de l' appel PCI/Authentication/CreateSession (étape 2).
 
APELLIDO Descripción OBLIGATORIO
 
operationUrl URL de inicialización de la autentificación entregada en la respuesta del Web Service PCI/Authentication/CreateSession en el objeto answer/AuthenticationSessionResponse#operationUrl. Sí
 
Ejemplo: .
 
  • answer.operationUrl: "https://api.cobroinmediato.tech/api-payment/V4/Charge/Public/Authenticate/Session/30641640cba14eab8e6766094fd201da;JSESSIONID=7A4beEA2d5fdbFeA7389F3B91a7bDBaBc8DA9df5.default-hostname"
 
3. Código de ejemplo con la clase KrAuthenticate y el método KrAuthenticate.authenticate
 
Ejemplo de integración utilizando bootstrap, JQuery y la biblioteca:
 
<!-- import JS -->
    [...]
    <script src="https://static.cobroinmediato.tech/static/js/authenticate-client/V1.0/kr-authenticate.umd.js"></script>
    [...]
    
    <form action='javascript:authenticateSession()'>
      <button id='submitButton' type='submit' class='btn btn-primary'>Authenticate</button>
    </form>
    [...]

    <script>
    // instantiate library
    const krAuthenticate = new KrAuthenticate('45789921:testpublickey_qSbs1nvRJEdy74KqANWo6TnGnRsTzwFMd9DYrO9OCdiHD');

    // Callback removing the overlay
    function myCallback(data){
        document.getElementById('overlay').remove();
    }

    // this is an example of overlay with a bootstrap spinner
    function buildOverlay(){
        let overlay = document.createElement('div');
        overlay.setAttribute('id', 'overlay');
        overlay.style.backgroundColor = '#D3D3D3';
        overlay.style.height = '100%';
        overlay.style.position = 'absolute';
        overlay.style.top = '0';
        overlay.style.opacity = '0.90';
        overlay.style.width = '100%'
        overlay.classList.add('d-flex', 'justify-content-center', 'flex-column', 'align-items-center');
        overlay.innerHTML = `
<div class="spinner-border" role="status">
<span class="sr-only">Loading...</span>
</div>
        `;
        document.body.appendChild(overlay);
    }

    // Main function triggered by button
    function authenticateSession(){
        document.querySelector('#submitButton').disabled = true;
        buildOverlay();
        krAuthenticate.authenticate("https://theUrlFromThePciCall", myCallback);
    }</script>
 
4. Ejecución de la autentificación
 
La biblioteca JavaScript ejecuta todas las acciones necesarias para la autentificación. La siguiente lista presenta casos hipotéticos:.
 
Casos de autentificación Descripción Test
 
3DS2 Frictionless, sans 3DS Method La autentificación se realiza sin ninguna interacción del usuario. 3DS2 - autentificación frictionless, sin 3DS Method
 
3DS2 Frictionless, avec 3DS Method Se ejecuta un script (3DS Method) antes de la autentificación, la que posteriormente se realiza sin ninguna interacción del titular. 3DS2 - autentificación frictionless, con 3DS Method
 
3DS2 Challenge, sans 3DS Method La autentificación requiere una acción del titular. 3DS2 - autentificación con challenge, sin 3DS Method
 
3DS2 Challenge, avec 3DS Method Se ejecuta un script (método 3DS) antes de las acciones de autentificación del titular. 3DS2 - autentificación con challenge, con 3DS Method
 
Consulte Tests y casos de uso para ver más ejemplos.
 
5. 3. Análisis del resultado de la autentificación
 
El resultado de la autentificación se envía automáticamente a la URL, establecida en el campoianTargetUrldurante la inicialización de la solicitud de autentificación.
Este resultado contiene los datos necesarios para la solicitud de autorización, como elCAVV.
 
Gestión del "timeout"
 
La sesión de autentificación dura 10 minutos.
Al final de este período, seRecomendadollamar al Web ServicePCI/Authentication/GetSessionpara obtener el resultado de la autentificación.
© 2024 Todos los derechos reservados de Cobro Inmediato
2.92.0-doc-1.11