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.
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:
| 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_sp | Id único de la tabla |
| categoria | Dato informativo sobre la categoria en la que estan divididos los servicios o endpoints. (comercios / autorizaciones / entidades / ceibo / etc. ) |
| descripcion | Descripcion del proposito del servicio / procedure |
| api_path_group | El 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_n | S/N. Indicador que permite simplificar el response del API en el caso de que tenga un solo item de respuesta |
| fecha_hora_ins | Fecha / hora de insercion del registro |
| usuario_ins | Usuario de Insercion |
| fecha_hora_upd | Fecha Hora de Actualizacion del registro. |
| usuario_upd | Usuario 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_sp | Id único de la tabla |
| categoria | Dato informativo sobre la categoria en la que estan divididos los servicios o endpoints. (comercios / autorizaciones / entidades / ceibo / etc. ) |
| descripcion | Descripcion del proposito del servicio / procedure |
| api_path_group | El 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_n | S/N. Indicador que permite simplificar el response del API en el caso de que tenga un solo item de respuesta |
| fecha_hora_ins | Fecha / hora de insercion del registro |
| usuario_ins | Usuario de Insercion |
| fecha_hora_upd | Fecha Hora de Actualizacion del registro. |
| usuario_upd | Usuario 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_usuario | Id único de la tabla |
| usuario | Sigla del Usuario |
| password | contraseña |
| fecha_alta | fecha de alta |
Paquete
CREDITOPY.PKG_API_CEIBO
Servicios
asdadasd