API Customizada

📝 Exemplo prático: Integração com ViaCEP

Para ilustrar como funciona uma API Customizada na Sinky, vamos utilizar o serviço público ViaCEP, que permite buscar informações de endereço a partir de um CEP.

🔧 1. Configuração da API

Cadastre a API no Marketplace da Sinky com os seguintes dados:

• Nome: Consulta CEP
• Descrição: Busca endereço pelo CEP informado
• URL:
  txt

  https://viacep.com.br/ws/01001000/json/

💡 Uso de variáveis dinâmicas

Como queremos que o CEP seja fornecido dinamicamente pelo workflow, substituímos o valor fixo por uma variável:

https://viacep.com.br/ws/${CEP}/json/

✅ A variável ${CEP} será substituída automaticamente pelo valor recebido no fluxo no momento da execução da requisição.

Você pode utilizar qualquer nome de variável, desde que ela seja corretamente informada na etapa de input do workflow.

2. Configuração de Variável para Workflow

Durante a configuração da API customizada, é possível atribuir uma variável do workflow para ser enviada dinamicamente na URL da API.

No exemplo abaixo, utilizamos a variável CEP, que será substituída pelo valor informado em tempo de execução do fluxo:

https://viacep.com.br/ws/${CEP}/json/

Além disso, ao configurar a API no Marketplace da Sinky, você pode fornecer um exemplo de resposta JSON. Esse exemplo é importante porque permite que o workflow reconheça automaticamente as variáveis de saída do nó, facilitando o mapeamento de dados para etapas seguintes do processo.

Exemplo de resposta configurada:

{
  "cep": "01001-000",
  "logradouro": "Praça da Sé",
  "bairro": "Sé",
  "localidade": "São Paulo",
  "uf": "SP"
}

Durante a configuração, é possível atribuir uma variável do workflow para ser enviada na URL da API. No exemplo abaixo, utilizamos CEP, que será substituído pelo valor informado em tempo de execução.

Além disso, ao configurar a API, você pode fornecer um exemplo de resposta JSON. Esse exemplo permite que o workflow reconheça as variáveis de saída do nó, facilitando o mapeamento dos dados que poderão ser usados em etapas seguintes do processo.

Exemplo de resposta configurada:

{
  "cep": "01001-000",
  "logradouro": "Praça da Sé",
  "bairro": "Sé",
  "localidade": "São Paulo",
  "uf": "SP"
}

Essas informações de saída (como logradouro, bairro, UF, etc.) poderão ser utilizadas em decisões, validações ou ações futuras dentro do seu fluxo.

3. Utilização no Studio

Na etapa final da configuração, o nó de integração com a API customizada aparece no workflow como um Produto/Serviço dentro do Studio da Sinky.

✅ O que acontece nesse ponto?

• O campo de entrada (CEP, no exemplo) já estará disponível, permitindo que o usuário informe o valor de forma dinâmica — seja por input manual, coleta automática, ou integração anterior no fluxo.
• Os dados de saída (definidos a partir do exemplo JSON configurado) ficam visíveis e acessíveis no nó.
• Esses dados podem ser utilizados nas etapas seguintes do fluxo, como:
  • Preenchimento automático de formulários
  • Regras de validação ou decisão
  • Envio de dados para outras integrações

🔄 Mapeamento no Workflow

Com isso, o workflow passa a ter:

• Entrada: cep (variável informada pelo usuário ou outra etapa anterior)
• Saídas:
  • logradouro
  • bairro
  • localidade
  • uf
  • ...entre outros campos configurados com base na resposta da API

Essa estrutura garante que as APIs customizadas se comportem de maneira integrada, reutilizável e consistente dentro do ecossistema da Sinky — ampliando o poder do seu fluxo com flexibilidade e controle.