Pular para o conteúdo principal
Conexões definem como o RWS Integration se autentica com APIs e serviços externos. Cada tipo de conexão lida com um padrão de autenticação diferente, desde chaves de API simples até fluxos OAuth 2.0. Escolha o tipo de conexão com base em como a API de destino espera a autenticação:
Tipo de ConexãoQuando Usar
SimpleAPI requer apenas headers (chaves de API, auth básico)
OAuth 2.0API usa autenticação baseada em token com credenciais de cliente
SessionAPI usa autenticação de sessão baseada em cookies
Google/GCPConexão com serviços do Google Cloud Platform

Simple

Apenas headers e query params

OAuth 2.0

Autenticação baseada em token

Session

Sessões baseadas em cookies

Google/GCP

Autenticação por service account

​
Simple

Tipo de conexão básico para APIs que autenticam via headers HTTP. Use quando a API requer uma chave de API estática, autenticação básica ou qualquer credencial baseada em header que não expira ou precisa de atualização.

​
Quando usar

  • APIs com chaves de API estáticas
  • Serviços usando headers Authorization: Basic
  • Qualquer API onde as credenciais são passadas diretamente nos headers

​
Configuração

Conexões Simple requerem apenas os headers que a API de destino espera. Nenhuma configuração adicional é necessária. Campos obrigatórios:
CampoDescrição
HeadersPares chave-valor para incluir em todas as requisições
Query ParamsPares chave-valor para incluir como parâmetros de URL

​
OAuth 2.0

Tipo de conexão para APIs que usam autenticação OAuth 2.0. O RWS Integration solicita um token de acesso do servidor OAuth e o inclui nas chamadas de API subsequentes.

​
Quando usar

  • APIs empresariais (Salesforce, HubSpot, Microsoft)
  • APIs que requerem fluxo de credenciais de cliente
  • Serviços onde os tokens expiram e precisam de atualização
  • Qualquer API que emite tokens Bearer

​
Configuração

Conexões OAuth 2.0 requerem detalhes sobre o endpoint de token, como extrair o token da resposta e como o token deve ser enviado nas requisições subsequentes. Campos obrigatórios:
CampoDescrição
Token TypeComo o token é enviado: Bearer (header Authorization) ou Api Token (header personalizado)
Header Attribute NameO nome do header usado para enviar o token nas requisições subsequentes. Para o tipo Bearer, é automaticamente definido como Authorization. Para o tipo Api Token, especifique o nome do header personalizado (ex: X-Auth-Token, Api-Key)
MethodMétodo HTTP para a requisição de token (tipicamente POST)
Base URLURL base do servidor OAuth
PathCaminho do endpoint para requisições de token (ex: /oauth/token)
Token Path in ResponseCaminho JSON para extrair o token do corpo da resposta

​
Token Type e Header Attribute Name

O Token Type determina o formato usado ao enviar o token, enquanto o Header Attribute Name especifica qual header carrega o token:
Token TypeHeader Attribute NameHeader da Requisição Enviado
BearerAuthorization (automático)Authorization: Bearer {token}
Api TokenPersonalizado (ex: X-Auth-Token)X-Auth-Token: {token}
Api TokenPersonalizado (ex: Api-Key)Api-Key: {token}
Exemplos de Token Path:O token path indica ao RWS Integration onde encontrar o token de acesso na resposta do servidor OAuth.
Estrutura da RespostaToken Path
{"access_token": "xyz"}access_token
{"data": {"token": "xyz"}}data.token
{"response": {"credentials": {"bearer": "xyz"}}}response.credentials.bearer

​
Session

Tipo de conexão para APIs que usam autenticação baseada em sessão via cookies. O RWS Integration realiza uma requisição de login, captura os headers Set-Cookie e mantém a sessão para requisições subsequentes.

​
Quando usar

  • Sistemas legados com autenticação baseada em sessão
  • APIs internas que requerem autenticação por cookie
  • Serviços web com fluxos de login
  • Sistemas que não suportam autenticação moderna baseada em token

​
Configuração

Conexões Session requerem os detalhes do endpoint de login. O RWS Integration gerencia automaticamente a captura de cookies e o gerenciamento de sessão. Campos obrigatórios:
CampoDescrição
MethodMétodo HTTP para a requisição de login (tipicamente POST)
Base URLURL base do servidor de autenticação
PathCaminho do endpoint de login (ex: /api/login)
O RWS Integration captura todos os headers Set-Cookie da resposta de login e os inclui automaticamente em todas as requisições subsequentes para a mesma URL base.

​
Google/GCP

Tipo de conexão para serviços do Google Cloud Platform. Usa autenticação de conta de serviço para acessar APIs GCP como Google Sheets, BigQuery, Cloud Storage e outros.

​
Quando usar

  • Integração com Google Sheets
  • Extração ou carregamento de dados do BigQuery
  • Operações de arquivos no Google Drive
  • Acesso ao Cloud Storage (GCS)
  • Qualquer serviço de API GCP

​
Configuração

Conexões GCP requerem uma conta de serviço com permissões apropriadas e os escopos OAuth para os serviços que você precisa acessar. Campos obrigatórios:
CampoDescrição
Google API ScopesEscopos OAuth necessários para os serviços GCP (um por linha)
Google Service Account (JSON)Conteúdo completo do arquivo JSON da chave da sua conta de serviço GCP

​
Escopos comuns

ServiçoEscopo
Google Sheets (leitura/escrita)https://www.googleapis.com/auth/spreadsheets
Google Sheets (somente leitura)https://www.googleapis.com/auth/spreadsheets.readonly
Google Drivehttps://www.googleapis.com/auth/drive
BigQueryhttps://www.googleapis.com/auth/bigquery
Cloud Storagehttps://www.googleapis.com/auth/devstorage.read_write

​
Permissões

A conta de serviço deve ter permissões IAM apropriadas para os recursos que você deseja acessar. Para Google Sheets, compartilhe a planilha diretamente com o endereço de email da conta de serviço (client_email no JSON).

​
Próximos passos

Paginação

Lide com diferentes padrões de paginação

Regras de Negócio

Transforme dados com JavaScript