SankhyaAPI.Client 4.3.0

👜 SankhyaAPI.Client

Projeto de integração com ERP Sankhya para operação de CRUD!

📑 Índice

• Sobre
• Instalação
• Configuração
• Funcionalidades
• Uso
• Licença

🚀 Sobre

Este projeto tem como objetivo disponibilizar, de maneira mais sucinta, métodos mais utilizados para manipulações e retornos de dados. Utilizando a própria API do Sankhya disponível aqui, o projeto abstrai os métodos para o usuário.

📦 Instalação

1. Na raiz do seu projeto, use o seguinte comando:

   dotnet add package SankhyaAPI.Client --version x.y.z
   

⚙ Configuração

Este pacote foi pensado para uso com injeção de dependência.

1. Configure o SankhyaClientSettings:

   SankhyaClientSettings sankhyaSettings = new SankhyaClientSettings();
   sankhyaSettings.BaseUrl = "https://seusistema.sankhya.com";
   sankhyaSettings.Usuario = "usuario";
   sankhyaSettings.Senha = "senha";
   builder.Services.Configure<SankhyaClientSettings>(sankhyaSettings);
   

2. Injete o serviço:

   builder.Services.AddSankhyaClient();
   

🧠 Validação de modelos

Todos os modelos devem herdar de SankhyaModelBase. Todas as propriedades devem ser NullableState<T>. As chaves primárias (com atributo [Key]) devem estar com:

• AutoEnumerable == true: obrigatoriamente UnSet
• AutoEnumerable == false: obrigatoriamente Set
• Nunca podem estar com Clear

⚙️ Funcionalidades

1. Exemplo de entidade:

   public class ProdutoEntity : SankhyaModelBase
   {
       [Key("CODPROD", true)] public NullableState<long> CodProd { get; set; }
       [XmlElement("CODVOL")] public NullableState<string> CodVol { get; set; }
       [XmlElement("DESCRPROD")] public NullableState<string> DescrProd { get; set; }
       [XmlElement("REFFORN")] public NullableState<string> RefForn { get; set; }
   }
   

2. Serviço da entidade usando nome da entidade como string:

   public class ProdutoClientService : BaseService<ProdutoEntity>
   {
       public ProdutoClientService(IOptions<SankhyaClientSettings> sankhyaApiConfig)
           : base(sankhyaApiConfig, "Produto") { }
   }
   

🧪 Uso

Inserir

var produtos = new List<ProdutoEntity>
{
    new() { CodProd = 1, CodVol = "UN", DescrProd = "Produto A", RefForn = "F123" },
    new() { CodProd = 2, CodVol = "UN", DescrProd = "Produto B", RefForn = "F456" }
};
var response = await produtoClientService.CreateManyAsync(produtos);

Atualizar

produtos[0].DescrProd = "Produto A Atualizado";
var response = await produtoClientService.UpdateManyAsync(produtos);

Buscar registros com FindAsync

string query = "this.CODPROD = 1 AND this.AD_ATIVO = 'S'";
var produtos = await produtoClientService.FindAsync(query);

Query tipada com QueryRawAsync

string script = "SELECT CODPROD, DESCRPROD FROM TGFPRO WHERE ATIVO = 'S'";
List<ProdutoEntity> resultado = await produtoClientService.QueryRawAsync<ProdutoEntity>(script);

Query como dicionário com QueryAsDictionaryAsync

string script = "SELECT CODPROD, DESCRPROD FROM TGFPRO WHERE ATIVO = 'S'";
List<Dictionary<string, object?>> resultadoDict = await produtoClientService.QueryAsDictionaryAsync(script);

📄 Licença

Este projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.