Workflows

Esta funcionalidad es exclusiva para conexiones con gateways Sensedia.

  • Orqueste el ciclo de vida de sus APIs con Workflows

    → Los Workflows le permiten definir requisitos específicos para cada etapa del ciclo de vida de una API. Así, es posible controlar cuándo y cómo puede avanzar.

    → Cada equipo puede crear su propio flujo, con reglas y criterios alineados a sus prácticas y objetivos. Esto garantiza flexibilidad sin renunciar a la gobernanza.

    → Al centralizar diferentes Workflows en un único lugar, su organización gana visibilidad y control sobre la trayectoria de las APIs, conectando la operación con la estrategia, ya que resulta fácil visualizar cómo trabaja cada equipo y cómo la estrategia de la organización se desarrolla en el día a día de las APIs.

ícono que representa workflows

Enlaces rápidos

En esta página, entenderá cómo:

Funcionamiento y tipos de workflows

Con Workflows, usted define qué debe suceder en cada etapa del ciclo de vida de la API y controla los criterios de avance entre ellas.

Tenemos dos tipos de workflows:

  • Organization Workflow
    Es el flujo de trabajo general de la empresa.
    Aplicado automáticamente a APIs que no poseen un Team Workflow configurado. Para garantizar el control a nivel organizacional, se permite solo un Organization Workflow.

  • Team Workflow
    Específico para cada equipo.
    Puede personalizarse para satisfacer las particularidades y procesos del equipo.
    Es posible tener múltiples Team Workflows, pero solo uno por equipo.

Pantalla principal con ejemplos de workflows:
Pantalla de workflows con los equipos Oganization Workflow Example 1 Example 2 y Example 3

Ejemplos de etapas de un workflow:
Ejemplo de workflow con las etapas sandbox development qa y production

Al crear o editar una API en Sensedia API Platform, usted define la etapa de la API en el campo Workflow Stage.

Una API solo puede moverse a una etapa si cumple con los requisitos específicos de esa etapa, configurados aquí en los Workflows de Adaptive Governance.

workflows api stage

Puede:

  • tener solo un Organization Workflow, que ya viene creado por defecto,

  • tener múltiples Team Workflows, siendo solo uno por equipo.

Aunque cada equipo solo pueda tener un workflow principal, un mismo equipo puede ejecutar procesos diferentes dependiendo del tipo de API (como corporativas, legadas, internas) o de la demanda (legal, innovación, estándar, etc.). En estos casos, para cada proceso distinto, el equipo puede registrarse múltiples veces – con nombres diferentes y representativos – para que cada registro se asocie a su respectivo workflow.

Ejemplo: Imagine un Equipo de Integraciones que maneja diferentes tipos de demandas. La forma de nombrar sus workflows puede guiar la acción:

  • Para atender a demandas regulatorias: Cree el workflow "Integrations - Regulatorio".

  • Para desarrollar nuevas funcionalidades: Utilice el workflow "Integrations - Nueva Funcionalidad".

  • Para gestionar APIs para uso interno: Nombre el workflow como "Integrations - Consumo Interno".

  • Para migrar APIs antiguas: El workflow puede llamarse "Integrations - Migración Legado".

Creando un Workflow

  1. Acceda a la pantalla Workflows.

    • Haga clic en Workflows en el menú lateral izquierdo o en la tarjeta en la pantalla inicial.
      Pantalla inicial con el elemento Workflows resaltado
      El orden de las tarjetas en esta pantalla puede variar

  2. Haga clic en el botón + en la esquina inferior derecha.
    Botón para agregar workflow

  3. En la ventana modal abierta, complete los campos obligatorios:

    • Name: Nombre del workflow.

    • Description: Descripción del workflow.

    • Team: Seleccione el equipo responsable.

  4. Haga clic en CREATE WORKFLOW.

Pantalla de creación de workflow

El nuevo workflow se mostrará como una tarjeta en la pantalla.

Clonando un Workflow

Puede clonar un Team Workflow existente para crear un nuevo workflow con las etapas ya configuradas.

  1. En la tarjeta de un workflow existente, haga clic en el ícono de clonación.
    Botón para clonar workflow

  2. Complete los campos: nombre, descripción y equipo.

  3. Haga clic en CLONE WORKFLOW.
    Pantalla de clonación de workflow con el botón CLONE WORKFLOW resaltado

  • El Organization Workflow no puede clonarse.

  • El nombre del nuevo workflow debe ser único.

  • El equipo asociado no puede estar ya vinculado a otro workflow.

Editando un Workflow

  1. En la tarjeta del workflow, haga clic en el ícono de edición.
    Botón para editar workflow

  2. Edite los campos deseados en la ventana modal.

  3. Haga clic en SAVE WORKFLOW para guardar o CANCEL para cancelar.

Usted no puede editar el Organization Workflow; solo puede configurar sus etapas.

Eliminando un Workflow

  1. En la tarjeta del workflow, haga clic en el ícono de la papelera.
    eliminar workflow

  2. Confirme la eliminación haciendo clic en DELETE.
    Pantalla de confirmación de eliminación de workflow

No es posible eliminar un workflow que tenga APIs asociadas a sus etapas.

Agregando etapas a un workflow

Siga los pasos a continuación para agregar una etapa a un workflow:

  1. Haga clic en el nombre del workflow para abrir la vista de las etapas.

  2. Haga clic en + en la esquina inferior derecha.
    Botón para agregar etapa

  3. En la ventana abierta, configure la etapa completando los campos obligatorios y haga clic en CREATE STAGE.

    • Name: Nombre de la etapa.

    • REQUISITES: Condiciones para que la API ingrese en esta etapa:

      • Environments: Ambientes donde la API debe estar desplegada.

      • Deployable Environments: Ambientes permitidos para despliegue.

      • Attributes (must have): Atributos obligatorios de la API.

      • Attributes (must not have): Atributos que la API no puede tener.

      • Interceptors (must have): Interceptores obligatorios en el flujo.

      • Interceptors (must not have): Interceptores no permitidos en el flujo.
        Consulte más detalles sobre esta configuración de interceptores.

      • API Maturity: Porcentaje mínimo de Interface Completeness.

        Formulario de creación de etapa


Configuración de interceptores

Configure los interceptores y defina si son obligatorios o no permitidos para la etapa. Esto ayuda a garantizar que las APIs sigan los estándares que defina.

  1. Haga clic en el ícono de configuraciones en el campo de interceptores.
    Para determinar los interceptores que:

    • Son obligatorios, haga clic en el ícono del campo "Interceptors (must have)";

    • No son permitidos, haga clic en el ícono del campo "Interceptors (must not have)".

      Botón de configuraciones de interceptores

      Puede alternar entre "must have" y "must not have" haciendo clic en el selector en la siguiente pantalla, sin tener que reconfigurar todo el interceptor.

  2. Seleccione el tipo de interceptor. Desplace la barra de desplazamiento si es necesario.
    Selección del tipo de interceptor

  3. Elija los interceptores que desea agregar. Desplace la barra de desplazamiento si es necesario.
    Lista de interceptores disponibles

  4. Defina las características que el interceptor debe tener para ser considerado en esta regla:

    • Execution point: Punto de ejecución del interceptor, que puede ser:

      • Request (solicitud) o

      • Response (respuesta).
        Selección del punto de ejecución del interceptor

    • Execution position: Posición de ejecución del interceptor, que puede ser:

      • Any (cualquier posición),

      • First (primero) o

      • Last (último).
        Selección de la posición de ejecución del interceptor

    • Flow: Flujo del interceptor, que puede ser:

      • All (todos los flujos).

      • Resource (recurso).

        • Elija entre All (todos los recursos), One (un recurso específico) o Some (algunos recursos).

      • Operation (operación).

        • Elija entre All (todas las operaciones), One (una operación específica) o Some (algunas operaciones).
          Selección del flujo del interceptor

  5. Confirme si el interceptor es obligatorio o no permitido, activando o desactivando el botón de alternancia.

  6. Haga clic en ADD INTERCEPTOR.

Todo nuevo workflow ya viene con una etapa inicial llamada Stage One.

Esta etapa no puede eliminarse; solo puede editarse.

Editando o eliminando etapas

  1. Para editar, haga clic en el ícono de edición en la tarjeta de la etapa.

  2. Modifique los campos según sea necesario y haga clic en SAVE STAGE.

  3. Para eliminar una etapa, haga clic en el ícono de eliminación (una papelera) en la tarjeta correspondiente. Confirme haciendo clic en DELETE.

Si edita las reglas de una etapa con APIs activas:

  • Vuelva a abrir y guarde esas APIs para que se apliquen las nuevas reglas.

  • Para APIs en producción, espere una nueva demanda de evolución y aplique las reglas en la nueva versión de la API.

  • No es posible eliminar una etapa con APIs asociadas.

  • La primera etapa del workflow no puede eliminarse.

Consejos de Uso

Estas son sugerencias para optimizar el uso de la funcionalidad de Workflows:

  • Etapa de entrada flexible: Es una buena práctica dejar la etapa inicial de un workflow sin requerimientos. Esto permite que todas las APIs se creen sin restricciones. Las etapas siguientes pueden tener requerimientos progresivamente más restrictivos, alineados con su estrategia de APIs y el proceso de desarrollo del equipo.

  • Flujo de ambientes: Utilice los ambientes de despliegue como base para crear las etapas de los workflows. Esto ayuda a mantener un flujo claro como "desarrollo → homologación → producción".

  • Actualización de reglas: Al modificar las reglas de una etapa que ya contiene APIs, recuerde guardar esas APIs nuevamente (incluso sin cambios) para que se apliquen las nuevas reglas.

Configuración de excepción

Con Exception settings usted configura APIs que pueden operar, durante un período determinado, sin seguir las reglas del workflow (APIs UNRESTRICTED). Esta opción es indicada para casos excepcionales o de emergencia, en los que es necesario liberar el uso de la API.

Utilice la excepción temporal para atender demandas excepcionales o de emergencia, sin necesidad de alterar sus configuraciones de gobernanza.

Es como si Adaptive Governance estuviera temporalmente deshabilitado — pero solo para las APIs incluidas como excepción.

Siga los pasos a continuación para configurar una excepción:

  1. Acceda a la pantalla del workflow.

  2. Haga clic en el botón Exception Settings en la parte superior derecha.
    Botón de configuraciones de excepción

  3. En la ventana abierta, comience a digitar el nombre de la API que desea agregar como excepción. Utilice el campo API.

  4. Seleccione la versión de la API.

  5. Defina un tiempo límite (en minutos) para que la excepción expire automáticamente.
    Pasado el tiempo configurado, la API volverá a seguir las reglas normales del workflow.

Pantalla de configuración de excepción

El sistema registra automáticamente la fecha y hora de la inclusión de la excepción y aplica un bypass total de requisitos. La excepción se comporta como si Adaptive Governance estuviera deshabilitado, pero solo para las APIs seleccionadas. Las APIs en estado de excepción pueden desplegarse directamente en cualquier environment, sin pasar por interceptors o políticas de la etapa.

  • La excepción es válida para cualquier workflow, incluso si la API se mueve de equipo/workflow.

  • Después del tiempo definido, la excepción expira y la gobernanza normal se restablece automáticamente.

Eliminando una excepción

Para eliminar manualmente una excepción antes de la expiración:

  1. En la misma ventana Exception Settings, haga clic en el ícono de la papelera junto a la API.
    Eliminar excepción

  • Incluso antes del plazo definido, la excepción puede eliminarse manualmente.

  • Al eliminarla, las reglas del workflow vuelven a aplicarse inmediatamente a la API, independientemente del tiempo de expiración configurado.
Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]