Crear Systema ABM
Documentación: Flujo Sistema ABM
Descripción
En esta sección se documenta el flujo de Alta, Baja y Modificación (ABM) de sistemas dentro del portal de seguridad.
Obtener Todos los Sistemas (sin filtro)
Para obtener todos los sistemas sin filtrar por scope del usuario, utiliza la siguiente solicitud GET:
GET https://apolo-app-platcom-platform-bff-api-api.cencosudx.com/abm-systems/all
Respuesta
Retorna un array con todos los sistemas registrados en la base de datos, sin aplicar filtros de scope.
Pasos para Crear Aplicaciones Base
Para crear una aplicación base, utiliza la siguiente solicitud POST:
POST https://apolo-app-platcom-platform-bff-api-api.cencosudx.com/systems/
Cuerpo de la Solicitud
{
"application": "string",
"name": "string",
"scope_ids": [
"6913810a2c17ee3a4e1287e0"
],
"external_services": [
{
"path": "http://api-svc.mdh-users.svc.cluster.local/api/v1/external/users",
"internalUrl": "/abm_users/search",
"method": "POST",
"headers": {
"authorization": ""
},
"response_type": "json"
},
]
}
Campos Detallados
Descripción de los Campos:
| Campo | Tipo | Descripción |
|---|---|---|
| application | string | Identificador único de la aplicación base. |
| name | string | Nombre descriptivo del sistema. |
| scope_ids | string[] | Lista de identificadores de alcance (scopes) asociados al sistema. |
| external_services | object[] | Servicios externos vinculados al sistema. |
| └ path | string | URL del servicio externo. |
| └ internalUrl | string | Ruta interna para acceder al servicio desde el sistema. |
| └ method | string | Método HTTP utilizado (por ejemplo, POST, GET). |
| └ headers | object | Encabezados HTTP requeridos para la solicitud. |
| └ response_type | string | Tipo de respuesta esperada (por ejemplo, json). |
Proceso
- El usuario accede al portal de desarrolladores y navega a la sección de sistemas.
- Selecciona la opción para crear un nuevo sistema (ABM).
- Completa el formulario con los datos requeridos (ver tabla de campos).
- El sistema valida la información ingresada.
- Si la validación es exitosa, se realiza la solicitud
POSTal endpoint correspondiente. - El sistema recibe la respuesta y notifica al usuario el resultado de la operación.
Pasos principales
- Ingresar al portal y autenticarse.
- Ir a la sección "Sistemas".
- Hacer clic en "Crear nuevo sistema".
- Completar los campos obligatorios y opcionales.
- (Opcional) Agregar servicios externos si corresponde.
- Enviar el formulario y esperar confirmación.
Consideraciones
- Los campos
application,nameyscope_idsson obligatorios. - Los servicios externos deben estar correctamente configurados para evitar errores de integración.
- Verificar que los encabezados y métodos HTTP sean los adecuados para cada servicio externo.
- El sistema puede requerir permisos específicos para crear o modificar sistemas.
- Se recomienda documentar internamente los cambios realizados para futuras referencias.