Sinqia Previdência
Objetivo
Este conector permite acessar as APIs do sistema da Sinqia, facilitando a integração com o módulo Cadastro, que expõe operações para participantes, beneficiários e pessoas físicas.
Criando um fluxo
Para usar o conector Sinqia em um fluxo da Fluid:
- Acesse a plataforma Fluid.
- Crie um novo fluxo e adicione um bloco de Ação.
- Selecione o conector Sinqia.
Criando conexão
Para autenticar a conexão com a API Sinqia, forneça as seguintes credenciais:
- Nome: parâmetro padrão em qualquer criação de uma conexão, te ajudará a identificar melhor sua conexão (campo obrigatório);
- Descrição: parâmetro padrão e opcional em qualquer criação de uma conexão, aqui você pode relatar detalhadamente para que fins servirá sua conexão;
- Chave do Cliente – obrigatório
- Chave Publica – obrigatório
- Basic – obrigatório
Configurando fluxo
Crie um fluxo (passo a passo Criar Fluxo) e arraste o conector Sinqia para o canvas.
Este conector possui uma estrutura hierárquica de configuração com três níveis:
- Módulo: atualmente disponível apenas o módulo Cadastro
- Recurso: entidade específica do módulo selecionado
- Operação: ação a ser realizada no recurso
Módulos, Recursos e Operações
Módulo: Cadastro
Recurso: Participante
- Busca por Plano
- Requer: plan (ID do plano do participante)
- Busca por CPF
- Requer: cpf (CPF do participante)
- Listar Participantes da SCAF Plus
- Requer:
- versão
- página: obrigatório, maior que zero
- tamanho da página: quantidade de registros por página (1-50)
Recurso: Beneficiário
- Busca por CPF
- Requer: cpf (CPF do beneficiário)
Recurso: Plano
- Lista de planos da pessoa física
- Requer: cpf (CPF da pessoa física)
Recurso: Pessoa Física
- Listar
- Requer:
- page: Número da página (ex: 1)
- size: Tamanho da página (ex: 10)
Módulo: Arrecadação
Recurso: Contribuição
- Busca Históricos de Valores
- Requer: cpf (CPF do participante)
- Busca contribuições por período
- Requer:
- cpf: CPF do participante
- startDate: Data inicial (formato: YYYY-MM-DD)
- endDate: Data final (formato: YYYY-MM-DD)
Na prática
Neste tópico criaremos um fluxo utilizando o conector Sinqia. O fluxo terá somente um passo que buscará o cadastro de um participante por CPF.
Passo participante
Assim ficará a Parametrização do nosso primeiro e unico passo:
Na aba Propriedades informamos o nome do passo e a conexão criada para o Sinqia:
Disparando o Fluxo
Com os passos configurados basta disparar o fluxo. Nesse caso não precisaremos informar um payload de entrada, pois os dados que estamos usando no exemplo estão fixos no conector. Após o disparo, o resultado do fluxo será apresentado em tempo real no canvas:
Conclusão
O conector Sinqia simplifica a integração com a API previdenciária, oferecendo operações diretas para consulta de dados sensíveis com segurança e flexibilidade.