Conectores
ERP
Sankhya
9 min
introdução o conector sankhya integra a fluid à api do sankhya , permitindo automatizar cadastros, consultas e atualizações de dados (clientes, produtos, pedidos e outros) pré requisitos acesso ao ambiente sankhya com permissões para api credenciais válidas token , appkey , usuário , senha definição do ambiente (produção/homologação) e url base, se aplicável ao seu tenant permissões e regras no sankhya para os recursos que serão manipulados (ex clientes, pedidos) como configurar no painel da fluid acesse conexões > nova conexão > sankhya em autenticação http , selecione api key em definir parâmetros em , escolha cabeçalho (header) em chaves , adicione appkey → valor da sua appkey no sankhya token → valor do token de acesso observação alguns tenants utilizam authorization bearer \<token> no lugar do cabeçalho token use o padrão do seu ambiente (opcional) requisição deixe sem preenchimento no cadastro da conexão os passos do conector definem verbo , url , corpo e cabeçalhos para cada recurso/operação quando sua organização padronizar uma url base , informe a em url e utilize variáveis nos passos (opcional) cache mantenha desabilitado por padrão ative somente para consultas; defina expiração e caminho no response para armazenamento (opcional) opções avançadas e proxy configure apenas se sua rede exigir clique em salvar conexão e utilize testar para validar campos de entrada (conexão) campo tipo obrigatório onde informar descrição token string sim chaves (header) → token ou authorization bearer \<token> token de acesso do sankhya preferir token de serviço com permissões mínimas necessárias appkey string sim chaves (header) → appkey chave do aplicativo registrada no sankhya usuário string quando exigido no corpo do passo de autenticação/login utilizado apenas em ambientes que requerem sessão por login senha string quando exigido no corpo do passo de autenticação/login utilizado apenas em ambientes que requerem sessão por login nota verbo, url, corpo e cabeçalhos específicos são definidos por passo conforme o recurso/ação campos de saída o passo sankhya retorna o corpo de resposta da api do sankhya estrutura comum { "status" "success|error", "data" { / objeto ou lista retornada pelo recurso / }, "errors" \[ { "code" " ", "message" " " } ] } a estrutura exata pode variar por recurso/versão da api utilize o transform da fluid para normalizar o retorno conforme seu domínio recursos e operações lista consolidada dos recursos suportados e suas operações recurso operações bairro cadastro, consulta banco consulta centro de resultados consulta cidade cadastro, consulta cfop consulta clientes consulta contato clientes cadastro, consulta como fazer alteração/inclusão de dados? altera/inclui como fazer consulta de dados? consulta tabela de preço consulta usuário consulta consulta de histórico de logs consulta empresa consulta endereço cadastro, consulta estoque consulta fornecedores cadastro, consulta kit de produtos cadastro, consulta motorista cadastro, consulta inclusão e alteração do item do pedido inclusão/alteração natureza consulta pedidos cadastro, consulta observação recursos e escopos dependem da habilitação no seu ambiente sankhya exemplo de uso aguardando exemplos reais para publicação assim que fornecidos, serão incluídos os cenários mínimos clientes > consulta com filtros e paginação pedidos > cadastro com itens (arrays) e observações possíveis erros código/tipo causa provável ação sugerida 401 não autorizado token/appkey inválidos ou expirados revogue e gere novo token confira usuário/senha e appkey 403 proibido usuário sem permissão para o recurso ajuste perfis no sankhya ou solicite liberação do módulo 404 não encontrado recurso/registro inexistente valide chaves (ex código do cliente) e filtros 409 conflito duplicidade em cadastro inclua lógica de upsert/consulta prévia 422 dados inválidos esquema incompatível, campos obrigatórios ausentes aplique validação json no passo e corrija o payload 429 limite de requisições rate limit do ambiente implemente retries exponenciais e backoff 5xx erro no provedor indisponibilidade momentânea re tente, acione monitoramento e fallback boas práticas segurança restrinja o acesso às credenciais e faça rotação periódica do token observabilidade habilite logs de requisição/resposta e correle ids de execução do fluxo paginação padronize limit e offset para grandes volumes resiliência implemente retries com backoff e circuit breaker em integrações críticas normalização use o transformer da fluid para mapear campos sankhya → domínio do seu negócio validações e conformidade o passo suporta corpo dinâmico , template e validação json para objetos e arrays aninhados recomenda se validar tipos, obrigatoriedade e formatos (datas, cnpj/cpf, cep) antes do envio referências api oficial sankhya https //developer sankhya com br/ https //developer sankhya com br/