SISTEMAS
Page tree

Versions Compared

Old Version 28

changes.mady.by.user Orlando Ojeda

Saved on

compared with

New Version 29

changes.mady.by.user Orlando Ojeda

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Resumen

Los servicios parametricos son una nueva funcionalidad incorporada en el API Ceibo ( o API Tarjeta habientes ) .

Esta funcionalidad permite crear nuevos servicios dentro del API de Ceibo tan solo configurando datos en tablas parametricas.

La esencia de esta funcionalidad es poder agilizar los procesos de desarrollo, automatizando la comunicacion entre el consumidor de un servicio (Ej: Frontend) y la base de datos (Ceibo), sin la necesidad de tener que programar por cada nuevo procedure un nuevo servicio que lo invoque.

En resumen, esta funcionalidad permite convertir un Procedimientos Almacenados en Servicios RESTFull que retornen JSON y que pueden ser invocados por cualquier programa.


Restricciones y Limitaciones

El uso de esta funcionalidad tiene unas de restricciones y limitaciones las cuales detallaremos a continuacion.

Expand
titleVer información

Servicios

Request:
  • Los servicios que son disponibilizados a traves de las parametrizaciones SOLO pueden recibir JSON como parametro de entrada.
  • Los unicos tipos de datos aceptados son NUMERO/TEXTO/FECHA. El tipo de dato FECHA debe enviarse como un texto en formato dd/mm/yyyy o dd/mm/yyyy hh24:mi:ss.
  • Mas adelante se detallarán ejemplos de como invocar a los servicios.
Response:
  • La respuesta del servicio siempre sera un JSON. El Servicio siempre devolverá una representacion de un STRING de cada dato retornado desde el Stored Procedure

Procedimientos Almacenados

Los procedimientos almacenados configurados deben cumplir obligatoriamente con los siguientes criterios:

Criterios Generales

  • Los procedimientos almacenados deben existir en @BAPY o en @OLPY. El API no se conecta a ninguna otra Base de Datos.
  • Los procedimientos deben poder ser vistos e invocados por el usuario: CREDITOPY.
  • Los procedimientos configurados deben estar programados de tal manera que PRIMERO se definan los parametros de ENTRADA , luego los de SALIDA.

Parametros de Entrada / Salida:

Entrada:

Solo son soportados los siguientes tipos de datos para los parametros de entrada:

  • Número (Number, Double, Decimal, etc. )
  • Texto (Varchar, CHAR, CLOB )
  • Fecha (Date)
  • Obs: Cuaquier otro tipo de dato será tratado como por el API  como un String.
Salida:

Solo son soportados los siguientes tipos de datos para los parametros de salida:

  • Número
  • Texto
  • Fecha
  • Cursor
  • Obs: Cuaquier otro tipo de dato será tratado como por el API  como un String. Con los eventuales errores que esto pueda conllevar.

Configuracion de Servicios

Entorno de Configuracíon

Todas las configuraciones para los Servicios parametricos se hacen en la base de datos BAPY CEIBO

Tablas de Configuracion

DER:

Tablas:

Expand
titleVer Info de Tablas
Tabla:API_CEIBO_PROCEDURES
Descripcion:

Tabla principal de configuraciones de los servicios parametricos.

En esta tabla se configuran los procedures que seran invocados, la base de datos donde esta alojado el SP y el path de accesion en el API

CAMPOS
id_api_spId único de la tabla
categoriaDato informativo sobre la categoria en la que estan divididos los servicios o endpoints. (comercios / autorizaciones / entidades / ceibo / etc. )
descripcionDescripcion del proposito del servicio / procedure
api_path_groupEl grupo o bloque en el que esta agrupado el servicio. Ej:
{group}/v1/getDatos
api_path_version

La version del servicio disponibilizado. Ej:

tarjetas/{version}/getDatos

api_path_name

El nombre del servicio. Ej:

tarjetas/v1/{servicio}

procedure_database

La base de datos en las que es ejecutado el Procedure (BAPY / OLPY)

procedure_schema

El nombre del esquema en el que se encuentra el procedure.

Obs: El usuario que ejecuta el SP es CREDITOPY, asi que debe tener permisos de ejecucion sobre el esquema.pkg.procedure

procedure_name

El nombre del procedimiento almacenado a ejecutar.

Obs: Configurar aqui el procedure procedure_name o pkg_name.procedure_name, sin el esquema. El API concatenará durante la ejecucion el esquema.sp_name o esquema.pkg_name.sp_name

simplificar_response_s_nS/N. Indicador que permite simplificar el response del API en el caso de que tenga un solo item de respuesta
fecha_hora_insFecha / hora de insercion del registro
usuario_insUsuario de Insercion
fecha_hora_updFecha Hora de Actualizacion del registro.
usuario_updUsuario de Actualizacion del registro.



Tabla:API_CEIBO_PROCEDURES
_PRMS_IN
Descripcion:

Tabla principal de configuraciones de los servicios parametricos.

En esta tabla se configuran los procedures que seran invocados, la base de datos donde esta alojado el SP y el path de accesion en el API

CAMPOS
id_api_spId único de la tabla
categoriaDato informativo sobre la categoria en la que estan divididos los servicios o endpoints. (comercios / autorizaciones / entidades / ceibo / etc. )descripcionDescripcion del proposito del servicio / procedureapi_path_groupEl grupo o bloque en el que esta agrupado el servicio. Ej:
{group}/v1/getDatosapi_path_version

La version del servicio disponibilizado. Ej:

tarjetas/{version}/getDatos

api_path_name

El nombre del servicio. Ej:

tarjetas/v1/{servicio}

procedure_database

La base de datos en las que es ejecutado el Procedure (BAPY / OLPY)

procedure_schema

El nombre del esquema en el que se encuentra el procedure.

Obs: El usuario que ejecuta el SP es CREDITOPY, asi que debe tener permisos de ejecucion sobre el esquema.pkg.procedure

procedure_name

El nombre del procedimiento almacenado a ejecutar.

Obs: Configurar aqui el procedure procedure_name o pkg_name.procedure_name, sin el esquema. El API concatenará durante la ejecucion el esquema.sp_name o esquema.pkg_name.sp_name

simplificar_response_s_nS/N. Indicador que permite simplificar el response del API en el caso de que tenga un solo item de respuestafecha_hora_insFecha / hora de insercion del registrousuario_insUsuario de Insercionfecha_hora_updFecha Hora de Actualizacion del registro.usuario_updUsuario de Actualizacion del registro.



Tabla:API_CEIBO_USERS
Descripcion:En esta tabla se registran los usuarios de aplicacion/login que es utilizado por el API para autenticarse y luego ejecutar los procedimientos almacenados
CAMPOS
id_usuarioId único de la tabla
usuarioSigla del Usuario
passwordcontraseña
fecha_altafecha de alta




Paquete

CREDITOPY.PKG_API_CEIBO

Servicios

asdadasd