Documentación de servicios API Iacpos - Venta online PDF

Preview

Summary

Documentacion de sevicios API Iacpos...

Description

Api Rest Bridge – IACPOS (Venta online) SICOMORO SERVICIOS INTEGRALES. S.L. Paseo Isabel La Católica, 6 - 2ª planta 50009 - ZARAGOZA CIF: B-99020547 Junio 2.020 - V.1.4.34

1 IACPOS. SICOMORO SERVICIOS INTEGRALES. S.L, (B-99020547) Paseo Isabel la Católica 6 50009, Zaragoza. www.iacpos.com

www.iacpos.com

ÍNDICE DE CONTENIDOS ÍNDICE DE CONTENIDOS .......................................................................................... 2 1. VERSIÓN ................................................................................................................. 5 2. INTRODUCCIÓN .................................................................................................... 5 3. CONECTIVIDAD..................................................................................................... 5 3.1.

IniciarLog .......................................................................................................... 5

3.2.

Crear token para recuperar contraseña ...................................................... 7

3.3.

Validar Token ................................................................................................... 8

4. CONFIGURACIÓN GENERAL............................................................................. 9 4.1.

Recuperar horario de apertura y cierre ....................................................... 9

5. RECUPERAR DISPONIBILIDAD....................................................................... 10 5.1.

Productos disponibles .................................................................................. 10

5.2.

Productos disponibles por día ..................................................................... 18

5.3.

Aforo disponible ............................................................................................. 23

5.4.

Aforo disponible (Hib) ................................................................................... 26

5.5.

Recintos de cada entrada ............................................................................ 30

5.6.

Aforo disponible por recinto y fecha ........................................................... 33

5.7.

Aforo disponible por recinto ......................................................................... 37

5.8.

Días de cierre en un rango de fechas ........................................................ 39

5.9.

Disponibilidad calendario ............................................................................. 42

5.10.

CodigosPromocionales ............................................................................. 47

5.11.

Vales promocionales ................................................................................. 49

6. ACTUACIONES SOBRE CUPOS...................................................................... 56 6.1.

Reservar cupo ............................................................................................... 56

6.2.

Cancelar cupo reservado ............................................................................. 58

6.3.

Confirmar cupo reservado y no reservado ................................................ 59

6.4.

Cancelar cupo ................................................................................................ 61

6.5.

Traspaso de aforo ......................................................................................... 63

6.6.

Modificar una sesión ..................................................................................... 64

7. VENTA ONLINE ................................................................................................... 66 2 IACPOS. SICOMORO SERVICIOS INTEGRALES. S.L, (B-99020547) Paseo Isabel la Católica 6 50009, Zaragoza. www.iacpos.com

www.iacpos.com

7.1.

Datos inicio ..................................................................................................... 66

7.2.

Recuperar cliente general para una venta o reserva .............................. 67

7.3.

Insertar venta ................................................................................................. 70

7.4.

Generar localizador....................................................................................... 83

7.5.

Confirmar una venta (acción = 2) ............................................................... 84

7.6.

Consultar estado de una reserva ............................................................... 85

7.7.

Recuperar una venta online ........................................................................ 86

7.8.

Recuperar reservas ...................................................................................... 97

7.9.

Marcar/desmarcar como pagada .............................................................. 104

7.10.

Insertar motivos reservas ....................................................................... 105

7.11.

Traer datos listas blancas ...................................................................... 106

7.12.

Modificar venta ......................................................................................... 108

7.13.

Anulación reserva / devolución venta .................................................. 117

8. CLIENTES y CLIENTES INTERNET .............................................................. 119 8.1.

Datos Cliente con filtro ............................................................................... 119

8.2.

Grupo motivo de descuento de cada entrada ........................................ 124

8.3.

Registrar o modificar un cliente web ........................................................ 125

8.4.

Contactos - Buscador ................................................................................. 128

8.5.

Login y recuperacion de datos del cliente cifrando en API .................. 130

8.6.

Registrar o modificar un cliente web cifrando en API ........................... 132

9. ENTORNOS ........................................................................................................ 135 9.1.

Base de datos .............................................................................................. 135

9.2.

Dirección de los servicios .......................................................................... 135

9.3.

Cliente Token ............................................................................................... 136

10.

FACTURACIÓN ONLINE .............................................................................. 136

10.1.

Generar una factura ................................................................................ 136

10.2.

Recuperar factura .................................................................................... 137

10.3.

Recuperar factura IVA ............................................................................ 141

10.4.

Recuperar factura referencia ................................................................. 141

10.5.

Actualizar datos de una factura ............................................................. 144

10.6.

Generar factura rectificativa ................................................................... 145

10.7.

Recuperar factura relación ..................................................................... 146

10.8.

Buscador factura...................................................................................... 147 3

IACPOS. SICOMORO SERVICIOS INTEGRALES. S.L, (B-99020547) Paseo Isabel la Católica 6 50009, Zaragoza. www.iacpos.com

www.iacpos.com

4 IACPOS. SICOMORO SERVICIOS INTEGRALES. S.L, (B-99020547) Paseo Isabel la Católica 6 50009, Zaragoza. www.iacpos.com

www.iacpos.com

1. VERSIÓN Autor

Fecha

Versión

Liset Huamán

16/06/2020

1.0.0

Mireya Contín

30/06/2020

1.0.1

Más información Actualizar información Entorno

2. INTRODUCCIÓN La finalidad del documento es poder implementar con facilidad todos los métodos de nuestra APIRest Bridge, que trabaja como puente entre las diferentes versiones de nuestra API.

3. CONECTIVIDAD Lo primero que tenemos que hacer para poder interactuar con la API, es generar un token que tiene un tiempo de vida útil, d espués del cual se tiene que volver registrar. 3.1.

IniciarLog

Permite registrar un nuevo token para poder hacer las llamadas a todos los métodos de la API. Se codifica en SHA512 antes de enviar a comprobar. Datos técnicos Petición HTTP POST a la URL {URLBASE}/IniciarLog Mensaje de petición { "nombre":"xxxxx", "id":"XXXXXXXXXXXX" } Datos relevantes de la petición Nombre: Cadena de texto que concatena nombre y contraseña y que estará dividida en 4 secciones mediante el patrón $A$. - Secciones: o 1º: Corresponde a parte inicial del nombre de usuario. No tiene que tener una longitud fija, lo que no puede ser el nombre completo, solo puede ser una parte de él. 5 IACPOS. SICOMORO SERVICIOS INTEGRALES. S.L, (B-99020547) Paseo Isabel la Católica 6 50009, Zaragoza. www.iacpos.com

www.iacpos.com

o 2º: Corresponde a parte inicial de la contraseña de usuario. No tiene que tener una longitud fija, lo que no puede ser la contraseña completa, solo puede ser una parte. o 3º: Resto del nombre de usuario no incluido en la primera sección. o 4º: Resto de la contraseña de usuario no incluida en la segunda sección. - Ejemplo: o Nombre usuario: NOMBRE o Contraseña: CONTRASEÑA o Nombre: NOM$A$CON$A$BRE$A$TRASEÑA id: Identificador único por cada nueva conexión, se recomienda usar la SesionId del navegador. Mensaje de respuesta OK { "DatosResult": "2H35H9Z9SBo6V8K0ncMNfs627K6K0YluxOWhTkG33sXZtqGW93qBN0h63avTKqDB0ht HmXHhRSHTvaofKPhTA2a4JxR6l23If5eO5UteqQa4C1G2vVD3g9RnIBWU0tvv", "Mensajes": [] } Datos relevantes de la respuesta OK DatosResult: Contiene el token con el que se realizarán las peticiones. Mensaje de respuesta de error KO En caso de no encontrar datos o producirse algún error, el servicio devolverá a null la propiedad DatosResult y uno o varios mensajes describiendo lo ocurrido en la propiedad Mensajes: { "DatosResult": null, "Mensajes": [ { "CodigoMensaje": "-2", "DescripcionMensaje": "Identificacion incorrecta" } ] } { "DatosResult": null, "Mensajes": [ { "CodigoMensaje": "-1", "DescripcionMensaje": "No existe el usuario" } ] }

6 IACPOS. SICOMORO SERVICIOS INTEGRALES. S.L, (B-99020547) Paseo Isabel la Católica 6 50009, Zaragoza. www.iacpos.com

www.iacpos.com

3.2.

Crear token para recuperar contraseña

Método que devuelve un token para modificar la contraseña. Datos técnicos Petición HTTP POST a la URL {URLBASE}/CrearTokenCambioContrasena Mensaje de petición { "ConexionIacpos": 144, "clienteAPI": { "Id": "XXXXXXXXXXXX", "Token": "2H35H9Z9SBo6V8K0ncMNfs627K6K0YluxOWhTkG33sXZtqGW93qBN0h63avTKqDB0ht HmXHh RSHTvaofKPhTA2a4JxR6l23If5eO5UteqQa4C1G2vVD3g9RnIBWU0tvv" }, "Email": "[email protected]", "Token": null, "HorasValido": null, "Contrasena": null } Datos relevantes de la petición Email: El email con el que el usuario se ha dado de alta. Mensaje de respuesta OK { "DatosResult": { "Token": "0x50193DA2F776F9687AFE4A7F96D967B0E8C346A6C9F171EC63412BE6EC0EABB2" }, "Mensajes": [] } Datos relevantes de la respuesta Token: Token con el que se podrá cambiar la contraseña. Mensaje de respuesta KO { "DatosResult": null, "Mensajes": [ { "CodigoMensaje": "0", "DescripcionMensaje": "El email no esta registrado" } ] } 7 IACPOS. SICOMORO SERVICIOS INTEGRALES. S.L, (B-99020547) Paseo Isabel la Católica 6 50009, Zaragoza. www.iacpos.com

www.iacpos.com

3.3.

Validar Token

Método que verifica si el token aún es válido o no. Datos técnicos Petición HTTP POST a la URL {URLBASE}/ExisteToken Mensaje de petición { "ConexionIacpos": 144, "clienteAPI": { "Id": "XXXXXXXXXXXX", "Token": "2H35H9Z9SBo6V8K0ncMNfs627K6K0YluxOWhTkG33sXZtqGW93qBN0h63avTKqDB0ht HmXHh RSHTvaofKPhTA2a4JxR6l23If5eO5UteqQa4C1G2vVD3g9RnIBWU0tvv" }, "Email": "[email protected]", "Token": "0x37CF3AAB9D57671D2A40B02CB15283ED15EB61892084AEB004D4D2110261C23D" , "HorasValido": "", "Contrasena": "" } Datos relevantes de la petición Email: Usuario del cliente registrado en el sistema. Token: Token a validar. Mensaje de respuesta OK { "DatosResult": true, "Mensajes": [] } DatosResult: Devuelve true si el token es válido. Mensaje de respuesta KO { "DatosResult": false, "Mensajes": [ { "CodigoMensaje": "0", "DescripcionMensaje": "No existe el token" } ] } DatosResult: Devuelve false si el token no es válido. 8 IACPOS. SICOMORO SERVICIOS INTEGRALES. S.L, (B-99020547) Paseo Isabel la Católica 6 50009, Zaragoza. www.iacpos.com

www.iacpos.com

4. CONFIGURACIÓN GENERAL Estos métodos permiten recuperar la configuración maestra del sistema de ticketing. 4.1.

Recuperar horario de apertura y cierre

Método que devuelve el horario de apertura y cierre configurados. Datos técnicos Petición HTTP POST a la URL {URLBASE}/Customan/GetHorario Mensaje de petición { "ConexionIacpos": 129, "clienteAPI": { "Id": "XXXXXXXXXXXX", "Token": "XXXXXXXXXXXXXX" }, "FechaIncicio": "2019/06/01", "FechaFin": "2019/06/01", "Id":0 } Datos relevantes de la petición Tipo: Identificador del elemento en la BBDD FechaIncicio: Fecha de inicio del filtrado. FechaFin: Fecha de fin del filtrado. Mensaje de respuesta OK { "DatosResult": { "Lista": [ { "Id": "1", "Nombre": "Horario semanal", "Descripcion": "Horario de lunes a sábado, tarifa normal", "TextoMostrar": "NORMAL", "HoraInicio": "01/01/1900 10:00:00", "HoraFin": "01/01/1900 18:00:00", "Lunes": "1", "Martes": "1", "Miercoles": "1", "Jueves": "1", "Viernes": "1", "Sabado": "1", 9 IACPOS. SICOMORO SERVICIOS INTEGRALES. S.L, (B-99020547) Paseo Isabel la Católica 6 50009, Zaragoza. www.iacpos.com

www.iacpos.com

"Domingo": "0", "Festivo": "0", "FechaFestivo": "", "Indefinido": "0" }, ....... ] }, "Mensajes": [] } Datos relevantes de la respuesta HoraInicio: Hora inicio del horario especial. HoraFin: Hora fin del horario especial. Lunes, Martes...: Día de la semana que se aplica el horario especial. Festivo: Indica si es horario especial por festivo marcado en el calendario. FechaFestivo: Indica la fecha del festivo marcado en el calendario. Indefinido: Indica si el día festivo se repite indefinidamente en el futuro. Mensaje de respuesta KO { "DatosResult": null, "Mensajes": [ { "CodigoMensaje": "01", "DescripcionMensaje": "Fecha:10/06/2019 11:33:42 Mensaje: No se han encontrado datos" } ] }

5. RECUPERAR DISPONIBILIDAD Estos métodos permiten recuperar los productos disponibles para la venta, estos se pueden ir filtrando por rango de fechas, tipología y permisos. 5.1.

Productos disponibles

Método para recuperar los productos disponibles de venta online. Datos técnicos Petición HTTP POST a la URL {URLBASE}/HIBDisponible Mensaje de petición { 10 IACPOS. SICOMORO SERVICIOS INTEGRALES. S.L, (B-99020547) Paseo Isabel la Católica 6 50009, Zaragoza. www.iacpos.com

www.iacpos.com

"ConexionIacpos": "117", "Idioma": "es-ES", "EnlaceMenuId": "132", "GruposInternet": "85", "Espectaculo": "0", "GrupoRecinto": "0", "Recinto": "0", "Fecha": "2019/02/01", "Hora": "", "FechaHasta": "2019/02/27", "HoraHasta": "", "IncluirSesiones": "1", "clienteAPI": { "Id": "XXXXXXXXXXXX", "Token": "2H35H9Z9SBo6V8K0ncMNfs627K6K0YluxOWhTkG33sXZtqGW93qBN0h63avTKqDB0ht HmXHhRSHTvaofKPhTA2a4JxR6l23If5eO5UteqQa4C1G2vVD3g9RnIBWU0tvv" }, "clienteCompra": { "Nombre": "XXXXX", "Contrasena": "XXXX", "NombreContacto": "", "PersonaPago": "", "CIFoDNI": "", "Telefono": "", "Direccion": "", "Ciudad": "", "ProvinciaContacto": "", "CodigoPostal": "", "Pais": "", "Email": "", "Apellidos": "", "Apellido2Contacto": "", "TelefonoMovilContacto": "", "TipoViaContacto": "", "PisoContacto": "", "Nacionalidad": "", "PrefijoInternacional": "", "Edad": "0", "Sexo": "", "otroEmail": "", "Nota": null, "TipoDescuento": null, "Descuento": "0.0", 11 IACPOS. SICOMORO SERVICIOS INTEGRALES. S.L, (B-99020547) Paseo Isabel la Católica 6 50009, Zaragoza. www.iacpos.com

www.iacpos.com

"PoliticaPrivacidad": null } } Datos relevantes de la petición ConexionIacpos: Número proporcionado por IACPOS asociado al servidor de nuestros clientes, parámetro obligatorio. Idioma: Idioma en el que se desea la definición de los productos, se puede enviar siempre “es-ES”, parámetro obligatorio. EnlaceMenuId: Número proporcionado por IACPOS, establece la categoría general del canal de venta (Particulares, Agencias, Colegios, etc), parámetro opcional. GruposInternet: Número proporcionado por IACPOS, establece una sub categoría de los productos disponibles por canal de venta (Particulares, Agencias, Colegios, etc), parámetro opcional. Fecha: Formato de fecha YYYY/MM/DD, fecha desde para recuperar los productos disponibles. Opcional, por defecto se recupera desde la fecha actual. FechaHasta: Formato de fecha YYYY/MM/DD, fecha hasta para recuperar los productos disponibles. Opcional, por defecto se recupera hasta final del mes actual. IncluirSesiones: 0 → No devuelve las sesiones disponibles. 1→ Devuelve las sesiones disponibles, sólo cuando los productos tienen control de aforo. ClienteAPI: En este apartado se tiene que enviar el token generado en el paso anterior y el identificador único, parámetro obligatorio. clienteCompra: En este apartado se tiene que enviar el usuario y contraseña de cliente registrado en el sistema, parámetro obligatorio: Nombre: [email protected] Contrasena: Contraseña encriptada con SHA512. Mensaje de la respuesta OK { "DatosResult": { "EspectaculoId": 0, "RecintoId": 0, "ButacasDisponibles": [], "AforosDisponibles": [ { "GrupoInternetId": 85, "EnlaceMenuId": 132, "NombreGrupo": "Jardines, Generalife y Alcazaba", "TipoReservaId": 59, "MaximoxGrupo": 10, "MinimoxGrupo": 1, "ValidarGratuitas": 0, "GruposInternetIdDisponible": [ { 12 IACPOS. SICOMORO SERVICIOS INTEGRALES. S.L, (B-99020547) Paseo Isabel la Católica 6 50009, Zaragoza. www.iacpos.com

www.iacpos.com

"ProductoId": 15, "BonoId": "15", "NombreProducto": "Promoción familias - Exclusivo Internet.", "DescripcionProducto": "Entradas válidas para 2 adultos y 2 niños de 4 a 12 años, precio en taquilla 70€", "Nombre": "Promoción familias especial", "Esbono": 1, "FechasVigenciaTarifa": [ { "FechaInicioTarifa": "27/11/2018 0:00:00", "FechaFinTarifa": "28/11/2018 23:59:00" } ], "divisaISO": "2", "BaseImponible": 24.090909090909, "PVPInternet": 26.5, "PVPInternetSinDescuento": 26.5, "Descuento": 0, "IVAPorcentaje": 10, "PVPTaquilla": 0, "Comision": 0, "IVAComision": 0, "DesglosarComision": 0, "NoAgrupar": 0, "TipoVenta": 0, "OrdenTarifa": 102, "MinimoTarifa": 1, "MaximoTarifa": 20, "ProductosRecintos": [], "NumeroTotalEntradasBono": 4, "ProductosBono": [ { "ProductoId": 1, "NombreProducto": "Adulto", "DescripcionProducto": "Entrada para mayores de 12 años", "Nombre": "Promoción familias especial"...