Glosario de términos
| Términos | Significado |
|---|---|
| NUSS | Número de seguridad social |
| Identificador | Es el identificador de AFILIACIONES. |
Definiciones en el esquema que contiene la lógica de los servicios
Esquema
SSOCIAL
Paquete
SSOCIA.PQ_ORDS_SS
Registro de accesos a los servicios
En la tabla SSOCIAL.CE_ORDS_LOGS
Definiciones en el esquema con ORDS activo
Esquema
RS_RRHH
Módulo
ss (Seguridad Social)
Plantillas
rest/v1.0/private/ce/nuss/consulta/
rest/v1.0/private/ce/nuss/gestion/
Manejadores
| Plantilla | Manejador | Parámetro | Body | Tipo autenticación | Comentario |
|---|---|---|---|---|---|
| rest/v1.0/private/ce/nuss/consulta/ | GET | Identificador | Bearer token | Consulta del NUSS asociado a un identificador de afiliaciones. Requiere autenticación por token previo. Para la obtención del token se requiere realizar la petición a la url https://daas<ENTORNO>.um.es/ords/zeus/rrhh/open-api-catalog/ss/ pasando un cliente y una contraseña previamente consensuada con el grupo de RRHH. La petición requiere el parámetro identificador de AFILIACIONES. El mensaje de respuesta será un JSON definido de esta forma: { "items": Si encuentra el NUSS asociado al identificador, el objeto items contendrá el elemento nuss con el valor que corresponda. El elemento count valdrá 1. Si no encuentra el NUSS, el objeto items aparecerá vacío y el elemento count aparecerá con valor 0. | |
| rest/v1.0/private/ce/nuss/gestion/ | GET | Identificador | Bearer token | Consulta del NUSS asociado a un identificador de afiliaciones. Requiere autenticación por token previo. Para la obtención del token se requiere realizar la petición a la url https://daas<ENTORNO>.um.es/ords/zeus/rrhh/open-api-catalog/ss/ pasando un cliente y una contraseña previamente consensuada con el grupo de RRHH. La petición requiere el parámetro identificador de AFILIACIONES. El mensaje de respuesta será un JSON definido de esta forma: { "items": Si encuentra el NUSS asociado al identificador, el objeto items contendrá el elemento nuss con el valor que corresponda. El elemento count valdrá 1. Si no encuentra el NUSS, el objeto items aparecerá vacío y el elemento count aparecerá con valor 0. | |
| rest/v1.0/private/ce/nuss/gestion/ | POST | Un JSON: { | Bearer token | Crea un registro en SSOCIAL.CE_DATOS_PERSONALES. La petición intenta una inserción de un registro nuevo con los valores pasados (identificador y NUSS). Requiere autenticación. Url para obtención de token: https://daas<ENTORNO>.um.es/ords/zeus/rrhh/oauth/token?grant_type=client_credentials, donde ENTORNO puede ser: desa, test o nada (para producción). Para la obtención del token se requiere un secreto que debe consensuarse con el grupo de RRHH, responsable del servicio. La petición manda en el cuerpo un JSON con el siguiente formato: Si la petición es correcta, devolverá lo siguiente: Si no es correcta, el campo result de la respuesta devolverá "Error", con una descripción en el campo msg | |
| rest/v1.0/private/ce/nuss/gestion/ | PUT | Un JSON: { | Bearer token | Modificar un registro en SSOCIAL.CE_DATOS_PERSONALES. Dado un identificador y un NUSS, actualiza el valor del NUSS para ese identificador. Requiere autenticación. Url para obtención de token: https://daas<ENTORNO>.um.es/ords/zeus/rrhh/oauth/token?grant_type=client_credentials, donde ENTORNO puede ser: desa, test o nada (para producción). Para la obtención del token se requiere un secreto que debe consensuarse con el grupo de RRHH, responsable del servicio. La petición manda en el cuerpo un JSON con el siguiente formato: Si la petición es correcta, devolverá lo siguiente: Si no es correcta, el campo result de la respuesta devolverá "Error", con una descripción en el campo msg | |
| rest/v1.0/private/ce/nuss/gestion/ | DELETE | Un JSON: { | Bearer token | Elimina un registro en SSOCIAL.CE_DATOS_PERSONALES. Es necesario indicar el identificador y el NUSS del registro a eliminar. Requiere autenticación. Url para obtención de token: https://daas<ENTORNO>.um.es/ords/zeus/rrhh/oauth/token?grant_type=client_credentials, donde ENTORNO puede ser: desa, test o nada (para producción). Para la obtención del token se requiere un secreto que debe consensuarse con el grupo de RRHH, responsable del servicio. La petición manda en el cuerpo un JSON con el siguiente formato: Si la petición es correcta, devolverá lo siguiente: Si no es correcta, el campo result de la respuesta devolverá "Error", con una descripción en el campo msg |
Autenticación de los clientes que hacen peticiones a los servicios
Cada cliente que requiera utilizar alguno de estos servicios deberá solicitarlo al grupo de RRHH poniendo un Jira a DJ-AT-RRHH, tal como este:
| Alta tarea JIRA | |||
|---|---|---|---|
| Tipo de tarea: | "Petición de Servicio" | Aplicación: | DJ-AT-RRHH |
| Resumen: | Solicitud acceso y credenciales a servicios web ORDS. Esquema: RS_RRH, Módulo: SS (ce/nuss) | ||
| Mensaje: | En el texto de la petición deberá justificar la necesidad del acceso y se especificará a qué plantilla se desea el acceso:
| ||
Una vez se resuelva el Jira y se autorice el acceso, el grupo de RRHH le facilitará un secreto (client_id y secret_id) que usted necesita conservar y que utilizará para poder obtener un token previo a cada petición que realice a los servicios. El token puede obtenerlo a través de estas urls. La duración del token será de una hora y deberá utilizarlo en cada una de las peticiones que realice pasándolo como tipo de autenticación Bearer token.
Acceso a la definición de la API con herramienta swagger
Accedemos a https://editor.swagger.io/ e importamos la siguiente URL:
{
"openapi": "3.0.1",
"info": {
"title": "ORDS generated API for ss",
"description": "Servicios de Seguridad Social",
"version": "1.0.0"
},
"servers": [
{
"url": "https://daasdesa.um.es/ords/zeus/rrhh/ss"
}
],
"paths": {
"/rest/v1.0/private/ce/nuss/consulta/": {
"get": {
"description": "\n\nConsulta del NUSS asociado a un identificador de afiliaciones.\n\nRequiere autenticación. Url para obtención de token: https://daas<entorno>.um.es/ords/zeus/rrhh/oauth/token?grant_type=client_credentials, donde entorno puede ser: desa, test o nada (para producción).\n\nLa petición manda el parámetro identificador de AFILIACIONES de la persona a la que queremos consultar su NUSS.\n\nEl mensaje de respuesta será un JSON definido de esta forma:\n\n\t{\n\t\t"items": [\n\t\t\t{\n\t\t\t\t"nuss": string\n\t\t\t}\n\t\t],\n\t\t"hasMore": boolean,\n\t\t"limit": integer,\n\t\t"offset": integer,\n\t\t"count": integer\n\t}\n\nSi encuentra el NUSS asociado al identificador, el objeto items contendrá el elemento nuss con el valor que corresponda. El elemento count valdrá 1.\nSi no encuentra el NUSS, el objeto items aparecerá vacío y el elemento count aparecerá con valor 0.\t \n\t ",
"parameters": [
{
"name": "identificador",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The queried record.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nuss": {
"$ref": "#/components/schemas/VARCHAR2"
}
}
}
}
}
}
}
}
}
}
}
},
"/rest/v1.0/private/ce/nuss/gestion/": {
"get": {
"description": "\nConsulta del NUSS asociado a un identificador de afiliaciones.\n\nRequiere autenticación. Url para obtención de token: https://daas<entorno>.um.es/ords/zeus/rrhh/oauth/token?grant_type=client_credentials, donde entorno puede ser: desa, test o nada (para producción).\n\nLa petición manda el parámetro identificador de AFILIACIONES de la persona a la que queremos consultar su NUSS.\n\nEl mensaje de respuesta será un JSON definido de esta forma:\n\n\t{\n\t\t"items": [\n\t\t\t{\n\t\t\t\t"nuss": string\n\t\t\t}\n\t\t],\n\t\t"hasMore": boolean,\n\t\t"limit": integer,\n\t\t"offset": integer,\n\t\t"count": integer\n\t}\n\nSi encuentra el NUSS asociado al identificador, el objeto items contendrá el elemento nuss con el valor que corresponda. El elemento count valdrá 1.\nSi no encuentra el NUSS, el objeto items aparecerá vacío y el elemento count aparecerá con valor 0.\n\t ",
"parameters": [
{
"name": "identificador",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The queried record.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nuss": {
"$ref": "#/components/schemas/VARCHAR2"
}
}
}
}
}
}
}
}
}
}
},
"put": {
"description": "\t \nModificar un registro en SSOCIAL.CE_DATOS_PERSONALES. Dado un identificador y un NUSS, actualiza el valor del NUSS para ese identificador.\n\nRequiere autenticación. Url para obtención de token: https://daas<entorno>.um.es/ords/zeus/rrhh/oauth/token?grant_type=client_credentials, donde entorno puede ser: desa, test o nada (para producción).\n\nLa petición manda en el cuerpo un **JSON** con el siguiente formato:\n\n {\n "identificador": string,\n "nuss": string\n }\n\nSi la petición es correcta, devolverá lo siguiente:\n\n\t{\n\t\t"result": "OK",\n\t\t"msg": "Registro actualizado con éxito"\n\t}\n\nSi no es correcta, el campo **result** de la respuesta devolverá "Error", con una descripción en el campo **msg**\n\n\t ",
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ss_ITEM"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "The successfully updated record.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"201": {
"description": "The successfully created record.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"x-codegen-request-body-name": "payload"
},
"post": {
"description": "\n\nCrea un registro en SSOCIAL.CE_DATOS_PERSONALES. La petición intenta una inserción de un registro nuevo con los valores pasados (identificador y NUSS).\n\nRequiere autenticación. Url para obtención de token: https://daas<entorno>.um.es/ords/zeus/rrhh/oauth/token?grant_type=client_credentials, donde entorno puede ser: desa, test o nada (para producción).\n\nLa petición manda en el cuerpo un **JSON** con el siguiente formato:\n\n {\n "identificador": string,\n "nuss": string\n }\n\nSi la petición es correcta, devolverá lo siguiente:\n\n\t{\n\t\t"result": "OK",\n\t\t"msg": "Registro insertado con éxito"\n\t}\n\nSi no es correcta, el campo **result** de la respuesta devolverá "Error", con una descripción en el campo **msg**\n\n\t ",
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ss_ITEM"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "The successfully created record.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"x-codegen-request-body-name": "payload"
},
"delete": {
"description": "\nElimina un registro en SSOCIAL.CE_DATOS_PERSONALES. Es necesario indicar el identificador y el NUSS del registro a eliminar.\n\nRequiere autenticación. Url para obtención de token: https://daas<entorno>.um.es/ords/zeus/rrhh/oauth/token?grant_type=client_credentials, donde entorno puede ser: desa, test o nada (para producción).\n\nLa petición manda en el cuerpo un **JSON** con el siguiente formato:\n\n {\n "identificador": string,\n "nuss": string\n }\n\nSi la petición es correcta, devolverá lo siguiente:\n\n\t{\n\t\t"result": "OK",\n\t\t"msg": "Registro borrado con éxito"\n\t}\n\nSi no es correcta, el campo **result** de la respuesta devolverá "Error", con una descripción en el campo **msg**\n\n\t ",
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ss_ITEM"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Deleted result.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"x-codegen-request-body-name": "payload"
}
}
},
"components": {
"schemas": {
"STRING": {
"type": "string"
},
"VARCHAR2": {
"type": "string"
},
"ss_ITEM": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"current_user": {
"type": "string"
}
}
}
}
},
"x-original-swagger-version": "2.0"
}
Entorno de pruebas de peticiones
Puede utilizar cualquier herramienta, como Postman o Insomnio para probar las peticiones a los servicios. El siguiente archivo json contiene la definición de las peticiones para Insomnio.