API - Interfaz de Programación de Aplicaciones (Application Programming Interface), es una integración que conecta dos programas.
Comience buscando la información de Basic Authentication en la tarjeta de Configuraciones - Integraciones - API EVO.
username: usuario obtenido en la tarjeta de integración de EVO.
password: contraseña obtenida en la tarjeta de integración de EVO.
Para utilizar la API de integración de ventas, el usuario debe tener permisos de consulta y edición de ventas en la clave habilitada.
Venda API
Para realizar una venta a través de la API, puede ser necesario el uso de otros puntos finales, de acuerdo a las necesidades y reglas de negocio de la empresa. Aquí está una lista de los puntos finales importantes:
buscar usuarios en EVO: los datos de clientes y oportunidades pueden obtenerse a través del DNI y el correo electrónico utilizando los siguientes puntos finales, siempre y cuando ya existan en la base de datos de EVO y se utilicen en la API de ventas:
autenticación de usuario y restablecimiento de contraseña: los siguientes endpoints se utilizan para restablecer contraseñas, iniciar sesión o cerrar sesión en el área de clientes en el entorno de EVO:
buscar IDs de contratos: los IDs de los contratos se encuentran en el siguiente endpoint:
ventas: el endpoint utilizado para realizar ventas a través de EVO es:
https://evo-integracao.w12app.com.br/api/v1/sales mediante POST (Ver el ejemplo)
Registrar nueva tarjeta de crédito
Para registrar una nueva tarjeta de crédito para la tokenización en el gateway de pagos, llama a nuestro componente externo EVO PAY - https://w12evopay.com/evocartao/evo-pay.js
Importante
Si el valor de la venta del contrato es "cero", no es necesario utilizar EVO PAY ni proporcionar los datos relacionados con el pago, como el token, el tipo de pago y el número de cuotas.
Ejemplos
CSS de EVO PAY - EVO PAY permite cualquier CSS directamente en el frontend de quienes están desarrollando, pero el orden de los campos de EVO PAY no se puede modificar.
JS de EVO PAY en HTML - Ejemplo de uso:
<html>
<head>
<title>EvoPay</title>
<script src="https://w12evopay.com/evocartao/evo-pay.js"></script>
</head>
<body>
<div>
<div class="my-5">
<h1>Site teste</h1>
</div>
<evo-cartao></evo-cartao>
</div>
<script>
var evoCartao;
setTimeout(() => {
evoCartao = document.querySelector('evo-cartao');
evoCartao.classes = 'form-no-style';
//Dados obtidos através da API https://evo-integracao.w12app.com.br/api/v1/configuration/gateway
evoCartao.gateway = {};
// Dados obtidos através da API https://evo-integracao.w12app.com.br/api/v1/configuration/card-flags
evoCartao.bandeiras = [];
// Dados obtidos através da API https://evo-integracao.w12app.com.br/api/v1/configuration/card-translation
evoCartao.traducoes = {};
evoCartao.addEventListener('eventoTokenGerado', (event) => {
console.log(event.detail);
});
evoCartao.addEventListener('eventoOcorreuErro', (event) => {
console.log(event.detail);
alert(event.detail);
});
}, 500);
function teste() {
evoCartao.dispatchEvent(new CustomEvent('salvar'));
}
</script>
</body>
</html>
Utilizando el HTML mencionado anteriormente, cuando se generan los datos de la tarjeta con éxito en la pasarela de pagos, la respuesta se obtendrá a través del evento 'eventoTokenGerado' y, en caso de error, a través del evento 'eventoOcorreuErro'.
API de ventas - Ejemplo de uso: El endpoint utilizado para realizar ventas a través de EVO es https://evo-integracao.w12app.com.br/api/v1/sales mediante POST.
{
"idBranch": “int”, // ID da filial de venda
"idMembership": “int”, // ID Contrato a ser vendido (se a venda for de serviço, passar o valor 0)
"idService": “int”, // ID serviço a ser vendido (se a venda for de contrato, passar o valor 0)
"memberData": { // Dados complementares do cliente caso o gateway solicite
"idMember": “int”,
"document": "string",
"zipCode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"idState": “int”
},
"cardData": { // Dados do cartão do aluno e token de cadastro do evoPay
"token": "string",
"temporaryToken": "string",
"branchToken": "string",
"totalInstallments": 0,
"truncatedCardNumber": "string",
"brand": "string",
"cardHolderName": "string",
"cardExpirationYear": 0,
"cardExpirationMonth": 0
},
"idProspect": 0, // ID do Prospect caso já tenha cadastro na base de dados
"idMember": 0, // ID do Cliente caso já tenha cadastro na base de dados
"voucher": "string", // Código do voucher caso seja utilizado na venda
"idCardMember": 0, // Código do cartão do cliente caso seja um cartão já cadastrado no cliente
"totalInstallments": 0, // Número de parcelas
"payment": 1 // Tipo pagamento : 1 – Cartão Crédito, 2 – Boleto, 3 – Crédito de venda, 4 – Transferencia Bancaria, 5 – ValorZero
}
¿Tiene preguntas? Acceda al centro de ayuda o póngase en contacto con nuestro equipo de atención al cliente a través del chat.
Accede a la documentación completa de la API clíc en el enlace api.abcevo.com.