Glossário

Este glossário contém os principais termos utilizados na documentação da solução de Workflow e Embedded, organizados por categorias. Ele oferece explicações rápidas para ajudar os usuários a entender conceitos técnicos relacionados à automação, integração e segurança.

Autenticação e Autorização

Authentication (Autenticação)

Autenticação é o processo de verificação da identidade de um usuário ou sistema antes de conceder acesso a recursos protegidos.

Authorization (Autorização)

Autorização é o processo de determinar as permissões de um usuário ou sistema autenticado, garantindo que ele possa acessar apenas os recursos autorizados.

Access Token (Token de Acesso)

Token de acesso emitido pelo servidor de autenticação. Ele é usado para autorizar requisições à API e possui um tempo de vida limitado, após o qual precisa ser renovado.

Refresh Token (Token de Renovação)

Token de renovação é um token de longa duração que permite que uma aplicação obtenha um novo access token sem a necessidade de reautenticação completa do usuário.

Token Expiration (Expiração do Token)

Expiração do token é o momento em que o token de acesso deixa de ser válido. Após a expiração, uma nova requisição deve ser feita para obter um novo token.

JWT (JSON Web Token)

JWT é um padrão aberto (RFC 7519) que define uma maneira compacta e segura de transmitir informações entre partes como um objeto JSON. Ele é amplamente utilizado para autenticação e autorização em APIs. Os tokens JWT são assinados digitalmente, garantindo a integridade dos dados.

Role (Papel ou Permissão)

Role define o conjunto de permissões atribuídas a um usuário ou sistema, especificando o que ele pode visualizar ou executar dentro de um workspace ou fluxo de trabalho.

Fluxos de Trabalho

Workspace (Ambiente de Trabalho)

Ambiente lógico onde os fluxos de trabalho e automações são configurados e gerenciados. Cada workspace pode conter múltiplos fluxos de trabalho, usuários e configurações específicas.

Blueprint (Modelo de Fluxo)

Um blueprint é um modelo reutilizável de um fluxo de trabalho que pode ser usado como base para a criação de novos fluxos. Ele contém a estrutura básica de um fluxo, como eventos, condições e ações.

Schema (Esquema)

Schema é a estrutura que define como os fluxos de trabalho são configurados, incluindo seus componentes, eventos, condições e ações. Ele é utilizado para criar, modificar ou replicar fluxos de trabalho.

Node (Nó)

Nó é um componente individual de um fluxo de trabalho que executa uma ação específica, como processar dados, enviar notificações ou integrar-se com sistemas externos.

Instance (Instância de Fluxo)

Uma instância de fluxo é a execução individual de um fluxo de trabalho. Cada vez que um fluxo é disparado, uma nova instância é criada, armazenando informações sobre seu status e resultado.

Event Trigger (Disparo de Evento)

Disparo de evento é um mecanismo que inicia a execução de um fluxo de trabalho. O evento pode ser interno (ex.: criação de um registro) ou externo (ex.: recepção de um webhook).

Integração

Webhook

Webhook é um mecanismo de notificação assíncrona que permite que um sistema informe outro sobre eventos importantes de forma automatizada. Quando um evento ocorre, o sistema emissor envia uma requisição HTTP (geralmente do tipo POST) para uma URL previamente configurada no sistema receptor, contendo os detalhes do evento.

Embedded

Embedded é uma funcionalidade que permite que a solução de Workflow seja embutida em outras plataformas, seja como uma solução white label completa ou exibindo fluxos de trabalho específicos, proporcionando uma experiência integrada e transparente ao usuário final.

White Label

White label refere-se à capacidade de personalizar visualmente uma solução (logotipo, cores, etc.) para que terceiros possam oferecer a plataforma como parte de seu próprio produto, mantendo a identidade visual de sua marca.

Generate URL (Gerar URL)

O endpoint generate_url é responsável por gerar uma URL que permite embutir a solução de Workflow em um iframe. Essa URL pode ser configurada para exibir a solução completa (white label) ou fluxos de trabalho específicos.

Iframe

Iframe é um elemento HTML que permite incorporar outra página web dentro de uma página principal. Ele é utilizado para exibir a solução embutida gerada pela API generate_url.

Credenciais e Chaves

Client Credentials (Credenciais de Cliente)

Fluxo de autenticação do OAuth 2.0 onde uma aplicação cliente solicita diretamente um token de acesso utilizando seu client_id e secret_id, sem a necessidade de intervenção de um usuário.

API Key (Chave de API)

Chave de API é um identificador único gerado pela plataforma, usado por aplicações cliente para autenticar e autorizar requisições feitas às APIs.

Dados e Exibição

Pagination (Paginação)

Paginação é uma técnica usada para dividir grandes conjuntos de dados em páginas menores, facilitando a exibição e manipulação dos resultados em interfaces de usuário e chamadas de API.