Workflows

Esta funcionalidade é exclusiva para conexões com gateways Sensedia.

  • Orquestre o ciclo de vida das suas APIs com Workflows

    → Os Workflows permitem que você defina requisitos específicos para cada estágio do ciclo de vida de uma API. Assim, é possível controlar quando e como ela pode avançar.

    → Cada time pode criar seu próprio fluxo, com regras e critérios alinhados às suas práticas e objetivos. Isso garante flexibilidade sem abrir mão da governança.

    → Ao centralizar diferentes Workflows em um único local, sua organização ganha visibilidade e controle sobre a jornada das APIs, conectando a operação à estratégia, já que fica fácil visualizar como cada time trabalha e como a estratégia da organização se desenrola no dia a dia das APIs.

ícone representando workflows

Links rápidos

Nesta página, você vai entender como:

Funcionamento e tipos de workflows

Com Workflows, você define o que deve acontecer em cada etapa do ciclo de vida da API e controla os critérios de avanço entre elas.

Temos dois tipos de workflows:

  • Organization Workflow
    É o fluxo de trabalho geral da empresa.
    Aplicado automaticamente a APIs que não possuem um Team Workflow configurado. Para garantir o controle em nível organizacional, é permitido apenas um Organization Workflow.

  • Team Workflow
    Específico para cada equipe.
    Pode ser customizado para atender às particularidades e processos da equipe.
    É possível ter múltiplos Team Workflows, mas apenas um por time.

Tela principal com exemplos de workflows:
Tela de workflows com os times Oganization Workflow Example 1 Example 2 e Example 3

Exemplos de estágios de um workflow:
Exemplo de workflow com os estágios sandbox development qa e production

Se preferir, assista ao vídeo sobre o funcionamento dos Workflows:

Ao criar ou editar uma API na Sensedia API Platform, você define o estágio da API no campo Workflow Stage.

Uma API só pode ser movida para um estágio se cumprir os requisitos específicos desse estágio, configurados aqui no Workflows do Adaptive Governance.

workflows api stage

Você pode:

  • ter apenas um Organization Workflow, que já vem criado por padrão,

  • ter múltiplos Team Workflows, sendo apenas um por time.

Mesmo que cada time só possa ter um workflow principal, um mesmo time pode executar processos diferentes dependendo do tipo da API (como corporativas, legadas, internas) ou da demanda (legal, inovação, padrão, etc.). Nesses casos, para cada processo distinto, o time pode ser registrado múltiplas vezes – com nomes diferentes e representativos – para que cada registro seja associado ao seu respectivo workflow.

Exemplo: Imagine um Time de Integrations que lida com diferentes tipos de demandas. A forma de nomear seus workflows pode guiar a ação:

  • Para atender a demandas regulatórias: Crie o workflow "Integrations - Regulatório".

  • Para desenvolver novas funcionalidades: Utilize o workflow "Integrations - Nova Funcionalidade".

  • Para gerenciar APIs para uso interno: Nomeie o workflow como "Integrations - Consumo Interno".

  • Para migrar APIs antigas: O workflow pode ser chamado de "Integrations - Migração Legado".

Criando um Workflow

  1. Acesse a tela Workflows.

    • Clique em Workflows no menu lateral esquerdo ou no card na tela inicial.
      Tela inicial com o item Workflows destacado
      A ordem dos cards desta tela pode variar

  2. Clique no botão + no canto inferior direito.
    Botão de adicionar workflow

  3. Na janela modal aberta, preencha os campos obrigatórios:

    • Name: Nome do workflow.

    • Description: Descrição do workflow.

    • Team: Selecione o time responsável.

  4. Clique em CREATE WORKFLOW.

Tela de criação de workflow

O novo workflow será exibido como um card na tela.

Assista ao vídeo que mostra como criar um workflow e inclui exemplos práticos do seu funcionamento em conjunto com a Plataforma de APIs Sensedia:

Clonando um Workflow

Vocẽ pode clonar um Team Workflow existente para criar um novo workflow com os estágios já configurados.

  1. No card de um workflow existente, clique no ícone de clonagem.
    Botão de clonar workflow

  2. Preencha os campos: nome, descrição e time.

  3. Clique em CLONE WORKFLOW.
    Tela de clonagem de workflow com destaque para o botão CLONE WORKFLOW

  • O Organization Workflow não pode ser clonado.

  • O nome do novo workflow deve ser único.

  • O time associado não pode já estar vinculado a outro workflow.

Editando um Workflow

  1. No card do workflow, clique no ícone de edição.
    Botão de editar workflow

  2. Edite os campos desejados na janela modal.

  3. Clique em SAVE WORKFLOW para salvar ou CANCEL para cancelar.

Você não pode editar o Organization Workflow, apenas configurar seus estágios.

Excluindo um Workflow

  1. No card do workflow, clique no ícone de lixeira.
    excluir workflow

  2. Confirme a exclusão clicando em DELETE.
    Tela de confirmação de exclusão de workflow

Não é possível excluir um workflow que tenha APIs associadas a seus estágios.

Adicionando estágios a um workflow

Siga os passos abaixo para adicionar um estágio a um workflow:

  1. Clique no nome do workflow para abrir a visualização dos estágios.

  2. Clique em + no canto inferior direito.
    Botão de adicionar estágio

  3. Na janela aberta, configure o estágio preenchendo os campos obrigatórios e clique em CREATE STAGE.

    • Name: Nome do estágio.

    • REQUISITES: Condições para a API entrar neste estágio:

      • Environments: Ambientes onde a API deve estar implantada.

      • Deployable Environments: Ambientes permitidos para deploy.

      • Attributes (must have): Atributos obrigatórios da API.

      • Attributes (must not have): Atributos que a API não pode ter.

      • Interceptors (must have): Interceptores obrigatórios no fluxo.

      • Interceptors (must not have): Interceptores não permitidos no fluxo.
        Veja mais detalhes sobre esta configuração de interceptores.

      • API Maturity: Porcentagem mínima de Interface Completeness.

        Formulário de criação de estágio

Veja o vídeo que mostra como adicionar um estágio a um workflow:


Configuração de interceptores

Configure interceptores e defina se são obrigatórios ou não permitidos para o estágio. Isso ajuda a garantir que as APIs sigam os padrões que você definir.

  1. Clique no ícone de configurações no campo de interceptores.
    Para determinar os interceptores que:

    • São obrigatórios, clique no ícone do campo "Interceptors (must have)";

    • Não são permitidos, clique no ícone do campo "Interceptors (must not have)".

      Botão de configurações de interceptores

      Você pode alterar entre "must have" e "must not have" clicando no seletor na tela seguinte, sem ter que reconfigurar todo interceptor.

  2. Selecione o tipo do interceptor. Desça a barra de rolagem se necessário.
    Seleção do tipo de interceptor

  3. Escolha os interceptores que deseja adicionar. Desça a barra de rolagem se necessário.
    Lista de interceptores disponíveis

  4. Defina as características que o inteceptor deve ter para se considerado nesta regra:

    • Execution point: Ponto de execução do interceptor, que pode ser:

      • Request (requisição) ou

      • Response (resposta).
        Seleção do ponto de execução do interceptor

    • Execution position: Posição de execução do interceptor, que pode ser:

      • Any (qualquer posição),

      • First (primeiro) ou

      • Last (último).
        Seleção da posição de execução do interceptor

    • Flow: Fluxo do interceptor, que pode ser:

      • All (todos os fluxos).

      • Resource (recurso).

        • Escolha entre All (todos os recursos), One (um recurso específico) ou Some (alguns recursos).

      • Operation (operação).

        • Escolha entre All (todas as operações), One (uma operação específica) ou Some (algumas operações).
          Seleção do fluxo do interceptor

  5. Confirme se o interceptor é obrigatório ou não permitido, ativando ou não o botão de alternância.

  6. Clique em ADD INTERCEPTOR.

Todo novo workflow já vem com um estágio inicial chamado Stage One.

Esse estágio não pode ser excluído, apenas editado.

Editando ou excluindo estágios

  1. Para editar, clique no ícone de edição no card do estágio.

  2. Altere os campos conforme necessário e clique em SAVE STAGE.

  3. Para excluir um estágio, clique no ícone de exclusão (uma lixeira) no card correspondente. Confirme clicando em DELETE.

Se editar as regras de um estágio com APIs ativas:

  • Reabra e salve essas APIs para que as novas regras sejam aplicadas.

  • Para APIs em produção, espere uma nova demanda de evolução e aplique as regras na nova versão da API.

  • Não é possível excluir um estágio com APIs associadas.

  • O primeiro estágio do workflow não pode ser excluído.

Dicas de Uso

Estas são sugestões para otimizar o uso da funcionalidade de Workflows:

  • Estágio de entrada flexível: É uma boa prática deixar o estágio inicial de um workflow sem requerimentos. Isso permite que todas as APIs sejam criadas sem restrições. Os estágios seguintes podem ter requerimentos progressivamente mais restritivos, alinhados à sua estratégia de APIs e ao processo de desenvolvimento do time.

  • Fluxo de ambientes: Utilize os ambientes de implantação como base para criar os estágios dos workflows. Isso ajuda a manter um fluxo claro como "desenvolvimento → homologação → produção".

  • Atualização de regras: Ao modificar as regras de um estágio que já contém APIs, lembre-se de salvar essas APIs novamente (mesmo que sem alterações) para que as novas regras sejam aplicadas.

Configuração de exceção

Com o Exception settings você configura APIs que podem operar, durante determinado período, sem seguir as regras do workflow (UNRESTRICTED APIs). Essa opção é indicada para casos excepcionais ou emergenciais, em que é necessário liberar o uso da API.

Utilize a exceção temporária para atender demandas excepcionais ou emergenciais, sem precisar alterar as suas configurações de governança.

É como se o Adaptive Governance estivesse temporariamente desabilitado — mas apenas para as APIs incluídas como exceção.

Siga os passos abaixo para configurar uma exceção:

  1. Acesse a tela do workflow.

  2. Clique no botão Exception Settings na parte superior direita.
    Botão de configurações de exceção

  3. Na janela aberta, comece a digitar o nome da API que deseja adicionar como exceção. Utilize o campo API.

  4. Selecione a versão da API.

  5. Defina um tempo limite (em minutos) para que a exceção expire automaticamente.
    Passado o tempo configurado, a API voltará a seguir as regras normais do workflow.

Tela de configuração de exceção

O sistema registra automaticamente data e hora da inclusão da exceção e aplica bypass total de requisitos. A exceção se comporta como se o Adaptive Governance estivesse desabilitado, porém somente para as APIs selecionadas. APIs em estado de exceção podem ser implantadas diretamente em qualquer environment, sem passar por interceptors ou políticas do estágio.

  • A exceção é válida para qualquer workflow, mesmo que a API seja movida de time/workflow.

  • Após o tempo definido, a exceção expira e a governança normal é restabelecida automaticamente.

Se preferir, assista ao vídeo que mostra como configurar exceções:

Deletando uma exceção

Para remover manualmente uma exceção antes da expiração:

  1. Na mesma janela Exception Settings, clique no ícone de lixeira ao lado da API.
    Remover exceção

  • Mesmo antes do prazo definido, a exceção pode ser excluída manualmente.

  • Ao excluir, as regras do workflow voltam a ser aplicadas imediatamente à API, independentemente do tempo de expiração configurado.
Thanks for your feedback!
EDIT

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