...
Sistema de gestión de empresas
Entidades
| Entidad | Descripción |
|---|
| Empresa | Contiene los datos básicos de una empresa. |
| DatosContacto | Contiene los datos de contacto de la empresa. |
| TipoIdentificador | Listado con los tipos de identificador fiscal (CIF, VAT, ...). |
| EmpresaClasificacion | Listado de relaciones entre empresas y clasificaciones. Las empresas se relacionarán únicamente con las clasificaciones del tipo "Sector Industrial". Ver definición de clasificaciones en SGI - ESB - SGO. | Info |
|---|
| La relación entre empresas y clasificaciones de tipo "Sector industrial" se considera algo que puede generalizarse a cualquier empresa y no algo específico de las empresas con las que se relaciona UM, es por ello que se ha modelado a nivel lógico en el diagrama. Al no haberse identificado por el momento necesidad de gestionar en ningún punto del SGI como producto, sino solamente en los formularios específicos de UM, la clasificación de una empresa no se ha modelado a nivel de objetos de transferencia del API ni tiene servicios específicos para su gestión. |
|
Modelo lógico
Image Added
API
Características generales que todas las API REST deben de cumplir:
Definición de los objetos
Empresa
| Nombre | Tipo | Descripción |
|---|
| id | String | Identificador de la empresa. |
|
| nombre | String | Nombre de la empresa. |
| tipoIdentificador | TipoIdentificador | Tipo de identificador fiscal de |
la personaEmpresaEconomica
...
Método
...
URL
...
Parámetros
...
Respuesta
...
Permisos
...
Descripción
| la empresa. Se devuelve la entidad TipoIdentificador con todos sus campos. |
| numeroIdentificacion | String | Número de identificación fiscal de la empresa del tipo indicado en "tipoIdentificador". |
| razonSocial | String | Razón social de la empresa. |
| datosEconomicos | Boolean | Indicador de si se trata de una empresa con datos económicos (está dada de alta en GENTE y en JUSTO) o sin datos económicos (está dada de alta solo en GENTE). |
| padreId | String | Identificador de la empresa padre o entidad principal. Estará informado en el caso de empresas que son subentidad de otra. |
| Bloque de código |
|---|
| language | java |
|---|
| theme | RDark |
|---|
| title | Empresa |
|---|
| collapse | true |
|---|
|
{
"id": "ent-002",
"nombre": "Empresa de Prueba",
"tipoIdentificador": {
"id":"tp-1",
"nombre":"CIF"
},
"numeroIdentificacion": "H11111111",
"razonSocial": "Empresa que es mayoritariamente de prueba del SGI",
"datosEconomicos": false,
"padreId": "ent-001"
} |
TipoIdentificador
| Nombre | Tipo | Descripción |
|---|
| id | String | Identificador de la entidad TipoIdentificador. |
| nombre | String | Nombre (Posibles valores: CIF, VAT, ...). |
| Bloque de código |
|---|
| language | java |
|---|
| theme | RDark |
|---|
| title | TipoIdentificador |
|---|
| collapse | true |
|---|
|
{
"id":"tp-1",
"nombre": "CIF"
} |
| Nombre | Tipo | Descripción |
|---|
| direccion | String | Dirección de contacto de la empresa. |
| Bloque de código |
|---|
| language | java |
|---|
| theme | RDark |
|---|
| title | DatosContacto |
|---|
| collapse | true |
|---|
|
{
"direccion": "C/ Uría, número 4, puerta A, 33002, Oviedo, Asturias, España"
} |
Servicios
| Info |
|---|
| Para componer la URL llamada completa, se debe anteponer a lo indicado en la columna URL lo siguiente: {HOST}/api/sgemp, donde {HOST} de deberá sustituir el dominio correspondiente al entorno al que se está accediendo y dicho acceso será por http o https según el caso. |
| Incluir página |
|---|
| SGI - ESB - SGEMP - Servicios Básicos |
|---|
| SGI - ESB - SGEMP - Servicios Básicos |
|---|
|
| Incluir página |
|---|
| SGI - ESB - SGEMP - Servicios Formly |
|---|
| SGI - ESB - SGEMP - Servicios Formly |
|---|
|
| Incluir página |
|---|
| SGI - ESB - SGEMP - Servicios Pasarela |
|---|
| SGI - ESB - SGEMP - Servicios Pasarela |
|---|
|
...
Colectivo
Documentación API
http://gitlab.treelogic.local/operaciones/hercules/sgi/sgi-esb/external-services/sgp-service/-/blob/master/src/main/resources/sgp-openapi.yaml
http://192.168.3.127:8280/API-SGP:v1.0.0?swaggertryit