An open API service indexing awesome lists of open source software.

https://github.com/guibranco/sankhya-sdk-dotnet

📊 ⚙️ Sankhya platform .NET SDK
https://github.com/guibranco/sankhya-sdk-dotnet

api dotnet dotnet-core dotnetcore dotnetframework erp hacktoberfest sankhya sankhya-api sankhya-nuget sankhya-platform-sdk sankhya-sdk-dotnet sdk

Last synced: 3 months ago
JSON representation

📊 ⚙️ Sankhya platform .NET SDK

Awesome Lists containing this project

README

          

# Sankhya SDK

📊⚙️ [Sankhya](https://www.sankhya.com.br/) .NET SDK.

[![GitHub license](https://img.shields.io/github/license/guibranco/Sankhya-SDK-dotnet)](https://github.com/guibranco/Sankhya-SDK-dotnet)
[![Time tracker](https://wakatime.com/badge/github/guibranco/Sankhya-SDK-dotnet.svg)](https://wakatime.com/badge/github/guibranco/Sankhya-SDK-dotnet)

![Sankhya logo](https://raw.githubusercontent.com/guibranco/Sankhya-SDK-dotnet/main/logo.png)

## CI/CD

| Build status | Last commit | Tests | Coverage | Code Smells | LoC |
|--------------|-------------|-------|----------|-------------|-----|
| [![Build status](https://ci.appveyor.com/api/projects/status/e1midttew0yykr59/branch/main?svg=true)](https://ci.appveyor.com/project/guibranco/Sankhya-SDK-dotnet/branch/main) | [![GitHub last commit](https://img.shields.io/github/last-commit/guibranco/Sankhya-SDK-dotnet/main)](https://github.com/guibranco/Sankhya-SDK-dotnet) | [![AppVeyor tests (branch)](https://img.shields.io/appveyor/tests/guibranco/Sankhya-SDK-dotnet/main?compact_message)](https://ci.appveyor.com/project/guibranco/Sankhya-SDK-dotnet/branch/main/tests) | [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=guibranco_Sankhya-SDK-dotnet&metric=coverage)](https://sonarcloud.io/dashboard?id=guibranco_Sankhya-SDK-dotnet) | [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=guibranco_Sankhya-SDK-dotnet&metric=code_smells)](https://sonarcloud.io/dashboard?id=guibranco_Sankhya-SDK-dotnet) | [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=guibranco_Sankhya-SDK-dotnet&metric=ncloc)](https://sonarcloud.io/dashboard?id=guibranco_Sankhya-SDK-dotnet)

## Code Quality

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/f6d787f9a2fe4116a7a8a0043489ba67)](https://app.codacy.com/gh/guibranco/Sankhya-SDK-dotnet/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/f6d787f9a2fe4116a7a8a0043489ba67)](https://app.codacy.com/gh/guibranco/Sankhya-SDK-dotnet/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)

[![codecov](https://codecov.io/gh/guibranco/Sankhya-SDK-dotnet/branch/main/graph/badge.svg)](https://codecov.io/gh/guibranco/Sankhya-SDK-dotnet)
[![CodeFactor](https://www.codefactor.io/repository/github/guibranco/Sankhya-SDK-dotnet/badge)](https://www.codefactor.io/repository/github/guibranco/Sankhya-SDK-dotnet)

[![Maintainability](https://api.codeclimate.com/v1/badges/d753c91651260c3da761/maintainability)](https://codeclimate.com/github/guibranco/Sankhya-SDK-dotnet/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/d753c91651260c3da761/test_coverage)](https://codeclimate.com/github/guibranco/Sankhya-SDK-dotnet/test_coverage)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=guibranco_Sankhya-SDK-dotnet&metric=alert_status)](https://sonarcloud.io/dashboard?id=guibranco_Sankhya-SDK-dotnet)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=guibranco_Sankhya-SDK-dotnet&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=guibranco_Sankhya-SDK-dotnet)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=guibranco_Sankhya-SDK-dotnet&metric=sqale_index)](https://sonarcloud.io/dashboard?id=guibranco_Sankhya-SDK-dotnet)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=guibranco_Sankhya-SDK-dotnet&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=guibranco_Sankhya-SDK-dotnet)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=guibranco_Sankhya-SDK-dotnet&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=guibranco_Sankhya-SDK-dotnet)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=guibranco_Sankhya-SDK-dotnet&metric=security_rating)](https://sonarcloud.io/dashboard?id=guibranco_Sankhya-SDK-dotnet)

[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=guibranco_Sankhya-SDK-dotnet&metric=bugs)](https://sonarcloud.io/dashboard?id=guibranco_Sankhya-SDK-dotnet)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=guibranco_Sankhya-SDK-dotnet&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=guibranco_Sankhya-SDK-dotnet)

---

## Installation

### Github Releases

[![GitHub last release](https://img.shields.io/github/release-date/guibranco/Sankhya-SDK-dotnet.svg?style=flat)](https://github.com/guibranco/Sankhya-SDK-dotnet) [![Github All Releases](https://img.shields.io/github/downloads/guibranco/Sankhya-SDK-dotnet/total.svg?style=flat)](https://github.com/guibranco/Sankhya-SDK-dotnet)

Download the latest `.zip` file from the [Releases](https://github.com/GuiBranco/Sankhya-SDK-dotnet/releases) page.

### Nuget package manager

| Package | Version | Downloads |
|------------------|:-------:|:-------:|
| **Sankhya** | [![Sankhya NuGet Version](https://img.shields.io/nuget/v/Sankhya.svg?style=flat)](https://www.nuget.org/packages/Sankhya/) | [![Sankhya NuGet Downloads](https://img.shields.io/nuget/dt/Sankhya.svg?style=flat)](https://www.nuget.org/packages/Sankhya/) |

---

## Features

The SDK provides a comprehensive implementation of Sankhya's web services. If the service you need is not included, you can independently implement the request/response and contribute via pull requests.

### Key Highlights

- **Know Services:** Predefined service wrappers for common operations.
- **Sankhya Wrapper:** Handles low-level HTTP requests, serialization, and authentication.
- **Extensibility:** Add custom functionality by extending the SDK.

For details, check the [Know Services Wiki](https://github.com/guibranco/Sankhya-SDK-dotnet/wiki/1.1.1-%E2%80%90-Know-Services-Request-Wrapper-(KSRW)).

---

## Usage

### Dependency Injection (IoC)

Register the Sankhya wrapper using the `CrispyWaffle` toolkit's [Service Locator](https://guibranco.github.io/CrispyWaffle/user-guide/serviceLocator/):

```csharp
var connectionSankhya = new Connection(); // Fill in your details
ServiceLocator.Register(() => new SankhyaContext(connectionSankhya), LifeStyle.Singleton);
```

#### Constructor Injection

```csharp
public class MyClass
{
private readonly SankhyaContext _sankhyaContext;

public MyClass(SankhyaContext sankhyaContext)
{
_sankhyaContext = sankhyaContext ?? throw new ArgumentNullException(nameof(sankhyaContext));
}
}
```

#### Manual Resolution

```csharp
var sankhyaContext = ServiceLocator.Resolve();
```

---

### Session Management

Retrieve and manage active sessions:

```csharp
var sessions = KnowServicesRequestWrapper.GetSessions();
foreach (var session in sessions)
{
KnowServicesRequestWrapper.KillSession(session.Id);
}
```

---

## Support

If you need help, feel free to [open an issue](https://github.com/guibranco/Sankhya-SDK-dotnet/issues/new).

---

## Contributing

Contributions are welcome! Check out the [CONTRIBUTING.md](CONTRIBUTING.md) guide for details.

---

## Contributors

Thanks to all contributors! 💙





guibranco


Guilherme Branco Stracini




fandriyaninkov


Fedor Andriyaninkov




pedrowindisch


Pedro Henrique




viktoriussuwandi


Viktorius Suwandi



### Bots





dependabot[bot]


dependabot[bot]




github-actions[bot]


github-actions[bot]




penify-dev[bot]


penify-dev[bot]




stack-file[bot]


stack-file[bot]




gitauto-ai[bot]


gitauto-ai[bot]




codefactor-io[bot]


codefactor-io[bot]






snyk-bot


Snyk bot