Skip to main content

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:

CampoTipoDescripción
applicationstringIdentificador único de la aplicación base.
namestringNombre descriptivo del sistema.
scope_idsstring[]Lista de identificadores de alcance (scopes) asociados al sistema.
external_servicesobject[]Servicios externos vinculados al sistema.
└ pathstringURL del servicio externo.
└ internalUrlstringRuta interna para acceder al servicio desde el sistema.
└ methodstringMétodo HTTP utilizado (por ejemplo, POST, GET).
└ headersobjectEncabezados HTTP requeridos para la solicitud.
└ response_typestringTipo de respuesta esperada (por ejemplo, json).

Proceso

  1. El usuario accede al portal de desarrolladores y navega a la sección de sistemas.
  2. Selecciona la opción para crear un nuevo sistema (ABM).
  3. Completa el formulario con los datos requeridos (ver tabla de campos).
  4. El sistema valida la información ingresada.
  5. Si la validación es exitosa, se realiza la solicitud POST al endpoint correspondiente.
  6. El sistema recibe la respuesta y notifica al usuario el resultado de la operación.

Pasos principales

  1. Ingresar al portal y autenticarse.
  2. Ir a la sección "Sistemas".
  3. Hacer clic en "Crear nuevo sistema".
  4. Completar los campos obligatorios y opcionales.
  5. (Opcional) Agregar servicios externos si corresponde.
  6. Enviar el formulario y esperar confirmación.

Consideraciones

  • Los campos application, name y scope_ids son 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.