DOCUMENTACIÓN API WEB by E-Brain

Venta Web v1.3

Nuestra Interfaz de Programación de Aplicaciones (API WEB) permite a los desarrolladores

comunicarse con Fitnessbrain para consultas y creación de ventas web.

Puede usar la API WEB para realizar las siguientes funciones:

● Consulta datos de usuarios.

● Consulta listado de productos vigentes.
● Carga de compra exitosa

Datos de conexión:

Para realizar la conexión con API WEB deberá utilizar los siguientes datos:

URL: {www}
accesskey: USER
secretkey: PASS

Estos datos serán suministrados por personal de E-Brain en un correo electrónico al inicio
del periodo de pruebas de uso de API WEB.

Método para Obtener Credencial {token}:

URL: {www}

METHOD: POST

HEADER: Authorization : Basci accesskey:secretkey

RESPONSE JSON:
status INTEGER (200 OK / 404 ERROR)
token STRING (credencial para realizar acciones sobre API WEB)
error STRING
Funciones API WEB:

valida_rut_compra()​ : ​Permite confirmar existencia de cliente en base de datos

URL​: {www} + ​valida_rut_compra

METHOD: GET

HEADER: Authorization : token {token}

DATA:
userid id del cliente a consultar

EXAMPLE:
{WWW}/​valida_rut_compra​/?userid=XXXXXXXX

RESPONSE JSON:
status INTEGER ( 200:OK / 404:ERROR )
rut id del cliente consultado
nombre nombre del cliente
apellido apellido del cliente
email correo eléctronico del cliente
celular celular dado por el afiliado
dirección dirección del afiliado
idacceso id interno del usuario en el sistema
activo si tiene un contrato vigente prepago o recurrente
rpid id del contrato de pago recurrente
nextmonth si tiene finiquito configurado
error existente sólo en caso de respuesta status:400

lista_productos() : ​Permite consultar información de los productos web existentes en

sistema

URL​: {www} + lista_productos

METHOD: GET

HEADER: Authorization : token {token}

PARAMETERS: (empty)

EXAMPLE:
{WWW}/​lista_productos​/

RESPONSE JSON (ARRAY):

gimnasio_name STRING
combo_id INT
nombre STRING
detalle ARRAY

DETALLE : (ARRAY)
tipo STRING
plan_id INT
nombre STRING
precio INT
periodo INT
unidad CHAR
tipo_plan STRING
valor_cuota INT
cuotas_iniciales ARRAY

CUOTAS_INICIALES: (ARRAY)
PAT INT
PAC INT
RP INT

venta_exitosa() : ​Informa al sistema que una venta web ha sido realizada exitosamente y
está será cargada en sistema

URL​: {www} + venta_exitosa

METHOD: POST

HEADER: Authorization : token {token}

DATA:
order_id STRING
combo_id INT
gimnasio_id INT
data TEXT

DATA: (TEXT) Es un base64 de JSON con las siguientes variables

holder
 plan
membrership_start
pt
professor
registration
enroll
payment
tbk_string

EXAMPLE:

base64_encode(json_encode([
'holder' => [
'id' => '123456789',
'name' => 'NOMBRE CLIENTE',
'lastn' => 'APELLIDO CLIENTE',
'email' => 'ventaweb@grupodtg.com'
],

'plan' => [
'123456789' => 3 //id cliente y id membresía seleccionada
],

'membership_start' => [
'123456789' => '2019-11-07'
],

'pt' => [
'123456789' => [
'1' => 4 //id producto seleccionado en sesiones
]
],

'professor' => [
'123456789' => [
'1' => '-' //profesor asignado, puede venir siempre en -
]
],

'registration' => [
'123456789' => 5 //id producto seleccionado en inscripción
],

'enroll' => [
'123456789' => 2 //id producto seleccionado en matrícula
],
 'payment' => [
'123456789' => [
'3' => 'PRE' //tipo de pago por ID de producto
]
],
'tbk_string'=>[
'tipo_tarjeta'=>'TC', //tipo de tarjeta con la que efectuó el pago inicial
'tarjeta'=>'MASTERCARD', //nombre de la tarjeta
'cod_autorizacion'=>'23456543', //código de autorización del comercio
'valor'=>'34565.00', //valor cancelado
],

'tokenrp'=>[
'tarjeta'=>'VISA', //nombre de la tarjeta
'4_numeros'=>'1234', //SOLO últimos 4 números de la tarjeta
'token'=>'XXXXX' //SOLO en caso de además ser pago recurrente se debe
enviar el token entregado por el comercio
]
]));

RESPONSE JSON (Exitoso):

status INTEGER ( 200:OK)
ticketid STRING Número de ID del registro de la compra
NOTA: En caso de ventas que contengan valores
afectos y exentos de IVA, retornará dos números
separados por una coma

RESPONSE JSON (Error):

status INTEGER ( 404:ERROR )
errorid INT
error STRING En caso de error, entrega el mensaje

Lista de ID errores:
1. Faltan parámetros en variable data
2. Id plan venta web informado no existe en sistema o se encuentra inactivo
3. Id gimnasio inexistente.
4. Número de orden ya existente en sistema
5. Valor de pago informado no corresponde al valor del producto web
6. Otros errores //la variable error contendrá el mensaje del error.