Inicio

Comienza a implementar la API de ventas de Jelou

La API de Jelou te ayudará a integrarte a nuestra plataforma de Jelou para así poder comenzar a concretar ventas con la gran fuerza de ventas que ofrece Jelou.

Para esto debes tener un ambiente de desarrollo donde puedas recibir y enviar datos desde y hacia la plataforma de Jelou. Jelou ofrece una API, esta API te permitirá comunicarte con la plataforma de Jelou para estar recibiendo datos de nuevos clientes y ventas concretadas en tiempo real. Esta API es muy fácil de integrar.

Nota: Si aún no tienes registrada tu cuenta en Jelou, antes de comenzar con el desarrollo, por favor envía un correo a Soporte Jelou

PASOS A SEGUIR

Una vez que la marca haya desarrollado los endpoint para recibir los datos del cliente y para recibir los datos de una compra, se pueden testear con el ambiente de pruebas de Jelou. Para esto, se debe comunicar al equipo de soporte y mencionar cuáles son los datos que se desean recibir de un cliente, así como sus respectivas reglas de validación (es decir, cantidad máxima de caracteres por campo, tipos de dato, etc.).

Pasos Área Comercial

Paso 1

Reunión con el área comercial para dialogar cómo es la marca y el manejo que se le dará.

Paso 2

Registro de credenciales para el funcionamiento de la marca con nosotros, a través de whatsapp business.

Paso 3

Definición de comisiones de venta con nuestro equipo de vendedoras.

Final

Integración de todos los datos y credenciales para la correcta información de la marca y su unión con Jelou.

Pasos Área Desarrollo

Paso 1

Al momento de finalizar la creación de la marca se deben crear las credenciales de autenticación para el portal de ambiente de pruebas y documentación.

Paso 2

Desarrollar los endpoints necesarios, para tu tipo de marca. Los cuales pueden ser registro de cliente y de venta, entre otros.

Paso 3

Comunicarte con personal de soporte para informar cuáles son los datos de cliente que necesita la marca que se registren.

Paso 4

Ingresar al ambiente de pruebas y comprobar que los endpoint de la marca funcionan correctamente y retornan las respuestas correctas.

Final

Después de que los endpoint queden funcionando, se puede proceder a solicitar la verificación de la marca. Esto es para comprobar que los datos son enviados correctamente y se reciben las respuestas correctas.

ESQUEMA DE COMUNICACIÓN

Es muy importante resaltar que la marca es la que recibe la información en este caso (registro de clientes y ventas), es por eso que es indispensable que tengan los endpoint para recibir dicha información.

La siguiente imagen muestra cómo se debe realizar la comunicación entre la API de Jelou y la API de la marca. API Jelou envía peticiones a API Marca y envía el token Bearer, este siempre debe estar presente para poder acceder a los recursos de la API Marca.
hero

Seguridad

El manejo de datos de clientes, así como de las ventas concretadas y productos, es un tema crítico para Jelou. Es por eso que se pide de manera obligatoria implementar un sistema de seguridad OAuth 2.0. Este sistema utiliza un token Bearer para poder acceder a los endpoints proporcionados por la marca.

La marca deberá proporcionar el token Bearer , este token se envía en el encabezado de la petición HTTP de la siguiente manera:

POST /resource/1/update HTTP/1.1 Authorization: Bearer RsT5OjbzRn430zqMLgV3Ia" Host: api.authorization-server.com description=Hello+World

URL de registro de cliente

La marca debe contar con una URL que sirva como endpoint para registrar los datos del cliente.

Esta URL debe ser de tipo POST

Un ejemplo de los datos que recibirá la marca en esta petición sería el siguiente:

Variable Tipo Valor
name string Indica el nombre del cliente. (Máximo 100 caracteres)
last_name string Indica el apellido del cliente. (Máximo 100 caracteres)
password string Debe contener un arreglo con los valores "encripted", "encripted_type" y "value".
encripted boolean Indica si la contraseña fue encriptada.
encripted_type string Debe indicar el tipo de encriptación de la contraseña.
value string Indica la contraseña del cliente. (Máximo 240 caracteres)
phone array Debe contener un arreglo con los valores "verified", "value" y "verified_date".
verified boolean Indica si el teléfono del cliente fue verificado.
value string Indica el teléfono del cliente. (Máximo 45 caracteres)
verified_date string Debe indicar el timezone en formato UTC de la fecha de verificación.
email array Debe contener un arreglo con los valores "verified", "value" y "verified_date".
verified boolean Indica si el correo fue verificado.
value string Indica el correo del cliente. (Máximo 200 caracteres)
verified_date string Debe indicar el timezone en formato UTC de la fecha de verificación.
{ "name": "Patrick", "last_name": "Marquise", "dni": "1213371860", "email": { "verified": true, "value": "ogorczany@hotmail.com", "verified_date": "2022-03-22T17:10:22" }, "phone": { "verified": true, "value": "9588560507096", "verified_date": "2022-03-22T17:10:22" }, "password": { "encripted": true, "encripted_type": "base64", "value": "TFRuZkB+K3K83j7ka75j9A0KhNcj182dihJ6f3Lp17ANRSs=" } }

Respuesta

La estructura debe ser como la siguiente:

Variable Tipo Valor
success boolean Debe indicar si la respuesta fue exitosa o no.
customer_id string Debe indicar el identificador del cliente dentro de la base de datos de la marca.
reg_date string Debe indicar la fecha y hora en que se realizó el registro.
timezone string Debe indicar el timezone en formato UTC de la fecha de registro.
action string Debe indicar si se creó o modificó un cliente (CREATE, UPDATE).
{ "success": true, "customer_id": "1", "reg_date": "2022-05-06T18:53:47.000000Z", "timezone": "America/Mexico_City", "action": "CREATE" }

URL de registro de venta

La marca debe contar con una URL que sirva como endpoint para registrar una venta que se haya concretado por parte de Jelou.

Esta URL debe ser de tipo POST

Un ejemplo de los datos que recibirá la marca en esta petición sería el siguiente:

Variable Tipo Valor
customer_id string Indica el identificador único del cliente. (Máximo 200 caracteres)
sku string Indica el identificador único del producto vendido. (Máximo 64 caracteres)
external_order_id string Indica el identificador único de la venta. (Máximo 64 caracteres)
payment_id string Indica el identificador del comprobante de pago en la pasarela de pago. (Máximo 64 caracteres)
{ "customer_id": 70, "sku": "036000291452", "external_order_id": "YOM-122739", "payment_id": "MP-579030" }

Respuesta

La estructura debe ser como la siguiente:

Variable Tipo Valor
success boolean Debe indicar si la respuesta fue exitosa o no.
order_id string Debe indicar el identificador de la venta registrada dentro de la base de datos de la marca.
reg_date string Debe indicar la fecha y hora en que se realizó el registro.
timezone string Debe indicar el timezone en formato UTC de la fecha de registro.
{ "success": true, "order_id": "MAR-100000083", "reg_date": "2022-06-10T19:18:05.000000Z" }

Errores

La siguiente tabla de errores muestran los posibles errores que debería retornar el ambiente de desarrollo de la marca, se debe retornar la estructura correcta y el código correcto.

La estructura debe ser como la siguiente:

Success

Boolean, debe indicar si la respuesta fue exitosa o no.

Message

String, debe indicar el mensaje de error.

Errors

Arreglo, si existen errores de validación, se indica por campo el tipo de error.

Code

Código de error conforme a la tabla.

{ "success": false, "message": "Ruta HTTP no encontrada", "errors": [], "code": 50 }
Código Error
11 Este error se muestra cuando las credenciales para acceder al servicio son incorrectas. Asegurarse que el token correcto haya sido enviado en el header de la siguiente manera.
12 Este error se muestra cuando existe un error de validación con los datos que fueron enviados.
50 Este error se muestra cuando la ruta del API no existe.
90 Este error se muestra cuando existe un error por parte del servidor.