Crear Aplicaciones Base

Documentación: Flujo Crear Aplicaciones Base

Descripción

Esta guía describe cómo crear una aplicación base asociada a un proveedor. El proceso implica registrar la configuración de la aplicación en la base de datos principal del país y la unidad de negocio correspondiente.

---

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/applications/

Cuerpo de la Solicitud

{
  "label": "string",
  "config": {
    "configs": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "__TYPE__": "DEFAULT"
  },
  "module_ids": [
    "string"
  ],
  "role_ids": [
    "string"
  ],
  "assets": {
    "label_local": "string",
    "description": "string",
    "image_base64": "string",
    "icon_base64": "string"
  }
}

Campos Detallados

Descripción de los Campos:

Campo	Tipo	Descripción
label	string	Nombre o etiqueta identificadora de la aplicación base.
config	object	Objeto con la configuración de la aplicación.
└ configs	object	Propiedades de configuración adicionales (clave-valor).
└ TYPE	string	Tipo de configuración (por ejemplo, DEFAULT, DATASHARING).
module_ids	string[]	Lista de identificadores de módulos asociados a la aplicación.
role_ids	string[]	Lista de identificadores de roles asignados a la aplicación.
assets	object	Información visual y descriptiva de la aplicación.
└ label_local	string	Nombre localizado de la aplicación.
└ description	string	Descripción breve de la aplicación.
└ image_base64	string	Imagen principal de la aplicación en formato base64.
└ icon_base64	string	Icono de la aplicación en formato base64.

Proceso

1. El usuario accede al portal de desarrolladores y navega a la sección de aplicaciones.
2. Selecciona la opción para crear una nueva aplicación base.
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 "Aplicaciones".
3. Hacer clic en "Crear nueva aplicación base".
4. Completar los campos obligatorios y opcionales.
5. (Opcional) Configurar propiedades adicionales en el objeto configs si corresponde.
6. Agregar información visual (imágenes e iconos) en formato base64.
7. Enviar el formulario y esperar confirmación.

Consideraciones

• Los campos label, module_ids, role_ids y assets son obligatorios.
• El campo TYPE dentro de config define el tipo de configuración (DEFAULT para configuración estándar).
• Las imágenes e iconos deben estar correctamente codificados en formato base64.
• Los module_ids y role_ids deben corresponder a módulos y roles previamente creados en el sistema.
• El sistema puede requerir permisos específicos para crear o modificar aplicaciones base.
• Se recomienda documentar internamente los cambios realizados para futuras referencias.
• Verificar que la aplicación base se haya creado correctamente en la base de datos del core del país y la unidad de negocio correspondiente.