sejam mais detalhistas com todos os passos na forma de autenticar e fazer o crud
- User
sejam mais detalhistas com todos os passos na forma de autenticar e fazer o crud
Assistant
Guia Completo: Automação n8n + API Sankhya com Autenticação e CRUD
1. AUTENTICAÇÃO NA API SANKHYA
A API do Sankhya geralmente usa autenticação via token JWT. Vamos detalhar todo o processo:
1.1 Obter Token de Autenticação
Passo 1: Adicione um nó HTTP Request para Login
- Clique em "+" para adicionar um novo nó
- Procure por "HTTP Request" e selecione
- Configure o nó com os seguintes parâmetros:
Configurações do Nó de Autenticação:
Nome do Nó: Autenticar Sankhya Método: POST URL: https://api.sankhya.com.br/loginHeaders:
{ "Content-Type": "application/json" }Body (JSON):
{ "appkey": "{{$env.SANKHYA_APP_KEY}}", "username": "{{$env.SANKHYA_USERNAME}}", "password": "{{$env.SANKHYA_PASSWORD}}" }Configurações Adicionais:
- Response Format: JSON
- Property Name: data
1.2 Extrair e Armazenar o Token
Passo 2: Adicione um nó "Set" após a autenticação
- Adicione um nó "Set"
- Configure para extrair o token:
Configurações:
Nome: Extrair Token Keep Only Set: ON Values to Set: - Name: token Value: {{$json.body.bearerToken}} - Name: jsessionid Value: {{$json.body.jsessionid.id}}
2. IMPLEMENTAÇÃO DO CRUD COMPLETO
2.1 CREATE (Criar Registro)
Exemplo: Criar um Parceiro/Cliente
Passo 3: Adicione um nó HTTP Request para CREATE
Configurações:
Nome: Criar Parceiro Método: POST URL: https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.saveRecordHeaders:
{ "Content-Type": "application/json", "Authorization": "Bearer {{$node["Extrair Token"].json["token"]}}", "Cookie": "JSESSIONID={{$node["Extrair Token"].json["jsessionid"]}}" }Body (JSON):
{ "serviceName": "CRUDServiceProvider.saveRecord", "requestBody": { "dataSet": { "rootEntity": "Parceiro", "includePresentationFields": "S", "dataRow": { "localFields": { "NOMEPARC": "{{$json.nome_cliente}}", "CGC_CPF": "{{$json.cpf_cnpj}}", "TELEFONE": "{{$json.telefone}}", "EMAIL": "{{$json.email}}", "CODCID": {{$json.codigo_cidade}}, "CODEND": {{$json.codigo_endereco}}, "NUMEND": "{{$json.numero}}", "COMPLEMENTO": "{{$json.complemento}}", "CLIENTE": "S", "FORNECEDOR": "N", "ATIVO": "S" } }, "entity": { "fieldset": { "list": "CODPARC,NOMEPARC,CGC_CPF,TELEFONE,EMAIL" } } } } }
2.2 READ (Buscar Registros)
Passo 4: Adicione um nó HTTP Request para READ
Buscar Lista de Parceiros:
Nome: Buscar Parceiros Método: POST URL: https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.loadRecordsHeaders: (mesmo do CREATE)
Body para buscar todos:
{ "serviceName": "CRUDServiceProvider.loadRecords", "requestBody": { "dataSet": { "rootEntity": "Parceiro", "includePresentationFields": "S", "offsetPage": "0", "criteria": { "expression": { "$": "CLIENTE = 'S'" } }, "entity": { "fieldset": { "list": "CODPARC,NOMEPARC,CGC_CPF,TELEFONE,EMAIL,DTCAD" } } } } }Buscar por ID específico:
{ "serviceName": "CRUDServiceProvider.loadRecords", "requestBody": { "dataSet": { "rootEntity": "Parceiro", "includePresentationFields": "S", "criteria": { "expression": { "$": "CODPARC = {{$json.codigo_parceiro}}" } } } } }
2.3 UPDATE (Atualizar Registro)
Passo 5: Adicione um nó HTTP Request para UPDATE
Configurações:
Nome: Atualizar Parceiro Método: POST URL: https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.saveRecordBody para atualização:
{ "serviceName": "CRUDServiceProvider.saveRecord", "requestBody": { "dataSet": { "rootEntity": "Parceiro", "includePresentationFields": "S", "dataRow": { "localFields": { "CODPARC": {{$json.codigo_parceiro}}, "NOMEPARC": "{{$json.nome_atualizado}}", "TELEFONE": "{{$json.telefone_novo}}", "EMAIL": "{{$json.email_novo}}" }, "key": { "CODPARC": { "$": "{{$json.codigo_parceiro}}" } } } } } }
2.4 DELETE (Excluir Registro)
Passo 6: Adicione um nó HTTP Request para DELETE
Configurações:
Nome: Excluir Parceiro Método: POST URL: https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.removeRecordBody:
{ "serviceName": "CRUDServiceProvider.removeRecord", "requestBody": { "dataSet": { "rootEntity": "Parceiro", "dataRow": { "key": { "CODPARC": { "$": "{{$json.codigo_parceiro}}" } } } } } }
3. WORKFLOW COMPLETO COM TRATAMENTO DE ERROS
3.1 Estrutura do Workflow
[Webhook Trigger] ↓ [Autenticar Sankhya] ↓ [Extrair Token] ↓ [Switch - Tipo Operação] ├─→ [CREATE] → [Resposta Sucesso] ├─→ [READ] → [Formatar Dados] → [Resposta] ├─→ [UPDATE] → [Resposta Sucesso] └─→ [DELETE] → [Resposta Sucesso] ↓ [Error Handler] → [Notificar Erro]3.2 Adicionar Switch para Tipo de Operação
Passo 7: Adicione um nó "Switch"
Configurações:
Nome: Tipo de Operação Mode: Rules Property: {{$json.operacao}} Rules: 1. Equal → "criar" → Output: CREATE 2. Equal → "buscar" → Output: READ 3. Equal → "atualizar" → Output: UPDATE 4. Equal → "excluir" → Output: DELETE
4. CONFIGURAÇÕES AVANÇADAS
4.1 Variáveis de Ambiente
No n8n, vá em Settings → Environment Variables e adicione:
SANKHYA_APP_KEY=sua_app_key_aqui SANKHYA_USERNAME=seu_usuario SANKHYA_PASSWORD=sua_senha SANKHYA_BASE_URL=https://api.sankhya.com.br4.2 Nó Function para Validação de Dados
Adicione antes do CRUD:
// Validar CPF/CNPJ function validarCpfCnpj(valor) { valor = valor.replace(/[^\d]+/g, ''); if (valor.length === 11) { // Validação CPF let soma = 0; let resto; if (valor === "00000000000") return false; for (let i = 1; i <= 9; i++) { soma = soma + parseInt(valor.substring(i-1, i)) * (11 - i); } resto = (soma * 10) % 11; if ((resto === 10) || (resto === 11)) resto = 0; if (resto !== parseInt(valor.substring(9, 10))) return false; soma = 0; for (let i = 1; i <= 10; i++) { soma = soma + parseInt(valor.substring(i-1, i)) * (12 - i); } resto = (soma * 10) % 11; if ((resto === 10) || (resto === 11)) resto = 0; if (resto !== parseInt(valor.substring(10, 11))) return false; return true; } return false; } // Validar dados de entrada const dados = $input.all()[0].json; if (!dados.nome_cliente || dados.nome_cliente.trim() === '') { throw new Error('Nome do cliente é obrigatório'); } if (!validarCpfCnpj(dados.cpf_cnpj)) { throw new Error('CPF/CNPJ inválido'); } if (!dados.email || !dados.email.includes('@')) { throw new Error('Email inválido'); } return $input.all();4.3 Tratamento de Resposta
Adicione um nó "Set" após cada operação CRUD:
// Nome: Formatar Resposta const response = $input.all()[0].json; if (response.status === 1) { return [{ json: { sucesso: true, mensagem: response.statusMessage, dados: response.responseBody.dataSet.dataRow } }]; } else { throw new Error(response.statusMessage || 'Erro na operação'); }
5. EXEMPLO DE REQUISIÇÃO COMPLETA
5.1 Webhook de Entrada
{ "operacao": "criar", "dados": { "nome_cliente": "João Silva", "cpf_cnpj": "12345678901", "telefone": "(11) 98765-4321", "email": "joao@email.com", "codigo_cidade": 1, "codigo_endereco": 1, "numero": "123", "complemento": "Apto 45" } }5.2 Resposta de Sucesso
{ "sucesso": true, "mensagem": "Registro salvo com sucesso", "dados": { "CODPARC": 12345, "NOMEPARC": "João Silva", "CGC_CPF": "12345678901" } }
6. DICAS DE DEBUGGING
-
Ative o modo Debug no n8n para ver todas as requisições
-
Use o nó "Stop and Error" para pausar o workflow e inspecionar dados
-
Adicione logs com o nó "Function":
console.log('Dados recebidos:', JSON.stringify($input.all()[0].json, null, 2)); return $input.all(); -
Teste cada etapa individualmente antes de conectar todo o workflow
-
Configure retry nos nós HTTP:
- Retry On Fail: ON
- Max Tries: 3
- Wait Between Tries: 1000ms
Este guia cobre todos os aspectos essenciais para integrar o n8n com a API do Sankhya. Lembre-se de sempre consultar a documentação específica da sua versão do Sankhya, pois endpoints e parâmetros podem variar entre versões.