SDK/API/Embedded
SDK, Embedded e API
🚧 Página em construção. Esta documentação está sendo expandida. Em breve traremos guias detalhados de implementação, exemplos por linguagem e referência completa. Por enquanto, esta página descreve o panorama geral e aponta para os recursos disponíveis hoje.
Objetivo
Esta seção é o ponto de entrada para times de engenharia que vão integrar a Fluid dentro do próprio produto — emitindo tokens para usuários finais, embutindo o canvas em uma aplicação existente ou chamando a API administrativa para automatizar a operação da plataforma.
Se você só vai criar fluxos e conexões pelo console, não precisa desta página. Comece por Primeiros Passos.
Quando usar cada caminho
A Fluid oferece três caminhos de integração programática, todos autenticados por Credenciais.
Caminho | Quando usar | Tipo de credencial |
|---|---|---|
SDK | Seu backend precisa emitir tokens de usuário para ativar Flowkits e integrações dentro do seu produto. | sdk |
Embedded | Você quer renderizar o canvas da Fluid embutido na interface do seu produto, já autenticado para o usuário correto. | embedded |
API | Seu sistema fala direto com a API administrativa da Fluid para provisionar workspaces, gerenciar membros ou automatizar operações de plataforma. | api |
Os três compartilham a mesma base de autenticação OAuth2 client credentials. A diferença está no que cada token autoriza fazer.
Pré-requisitos
Independentemente do caminho escolhido, você vai precisar de:
- uma credencial criada no console, com o tipo correspondente ao seu caso de uso
- o client_id e o client_secret dessa credencial, armazenados em variável de ambiente ou secret manager no seu backend
- acesso ao Fluid Playground para validar o fluxo antes de implementar
Consulte a página de Credenciais para o passo a passo de criação e gestão.
Testando antes de implementar
Antes de escrever qualquer linha de código no seu backend, valide o fluxo de autenticação no Fluid Workbench. Ele permite executar a cadeia completa — client credentials → token M2M → bootstrap token → sessão — direto pela interface, sem dependências.
Útil para confirmar que sua credencial está configurada corretamente, inspecionar a estrutura dos tokens retornados e isolar problemas antes de partir para o código.
Use o Workbench para:
- confirmar que sua credencial está configurada corretamente
- inspecionar a estrutura dos tokens retornados
- reproduzir o fluxo de ponta a ponta antes de levar para produção
- isolar problemas: se funciona no Workbench e não no seu código, o problema está no código
Acesse o Workbench em Configurações → Credenciais → Workbench.
O que vem por aí
Estamos preparando guias dedicados para cada caminho, incluindo:
- instalação e setup do @fluidapi/sdk
- exemplos completos em Node.js, Python e Go
- referência de eventos e callbacks do Embedded
- catálogo de endpoints da API administrativa
- tratamento de erros e troubleshooting
Enquanto isso, se precisar de orientação técnica para sua integração, abra um chamado pelo Portal de Chamados ou fale com seu Customer Success Manager.
Links relacionados
- Credenciais — como criar e gerenciar credenciais M2M
- Customers — vínculo entre tokens emitidos e organizações dos seus usuários finais
- API Keys — alternativa para webhooks e disparos passivos
- Gateway Fluid — endpoints de disparo de fluxo