Sankhya 3.0.694

Sankhya SDK

📊⚙️ Sankhya .NET SDK.

CI/CD

Build status	Last commit	Tests	Coverage	Code Smells	LoC

Code Quality

Installation

Github Releases

Download the latest zip file from the Release page.

Nuget package manager

Package	Version	Downloads
Sankhya

Features

This SDK implements many of Sankhya's web services. Some of them are called Know Services. If the service you seek is not set in the SDK, you can implement the service request/response independently (and use it on your code or submit a pull request to this repository).

Some Request Wrappers allow you to make some requests easily.

Known Services

Wiki page about KSRW

Sankhya Wrapper

The last-mile operations are done on these wrappers. This class defines all HTTP request/response, login/logout, serialization, and download/upload operations.

Avoid using this class directly from your implementation. Only call its methods if you are extending the SDK's functionality or implementing a new feature. Otherwise, prefer using one of the request wrappers or the Sankhya Context class.

Usage

Service registration (IoC / DI)

This SDK is based on CrispyWaffle toolkit, so you can use its Service Locator feature to register it.

Assuming you are using Crispy Waffle, you can register the Sankhya wrapper in the Bootstrapper.cs file this way:

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

Later, when you need to access the Sankhya Context in your code, you can just pass it as the constructor's argument or retrieve it from Service Locator

Constructor argument

public class MyClass {

    private readonly SankhyaContext _sankhyaContext;

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

Retrieving manually

var sankhyaContext = ServiceLocator.Resolve<SankhyaContext>();

Know Services Wrapper

The KnowServicesRequestWrapper is a static class that can be used anywhere since SankhyaContext is registered through ServiceLocator.

Session management

You can use this to get all active sessions in Sankhya and kill them one by one:

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

Support

Please open an issue for support.

Contributing

Refer to CONTRIBUTING.md to learn how to contribute to this project!

Contributors

<table> <tbody> <tr> <td align="center"> <a href="https://github.com/guibranco"> <img src="https://avatars.githubusercontent.com/u/3362854?v=4" width="100;" alt="guibranco"/> <br /> _{<b>Guilherme Branco Stracini</b>} </a> </td> <td align="center"> <a href="https://github.com/fandriyaninkov"> <img src="https://avatars.githubusercontent.com/u/18394528?v=4" width="100;" alt="fandriyaninkov"/> <br /> _{<b>Fedor Andriyaninkov</b>} </a> </td> <td align="center"> <a href="https://github.com/pedrowindisch"> <img src="https://avatars.githubusercontent.com/u/30203228?v=4" width="100;" alt="pedrowindisch"/> <br /> _{<b>Pedro Henrique</b>} </a> </td> <td align="center"> <a href="https://github.com/viktoriussuwandi"> <img src="https://avatars.githubusercontent.com/u/68414300?v=4" width="100;" alt="viktoriussuwandi"/> <br /> _{<b>Viktorius Suwandi</b>} </a> </td> </tr> <tbody> </table>

Bots

<table> <tbody> <tr> <td align="center"> <a href="https://github.com/dependabot[bot]"> <img src="https://avatars.githubusercontent.com/in/29110?v=4" width="100;" alt="dependabot[bot]"/> <br /> _{<b>dependabot[bot]</b>} </a> </td> <td align="center"> <a href="https://github.com/github-actions[bot]"> <img src="https://avatars.githubusercontent.com/in/15368?v=4" width="100;" alt="github-actions[bot]"/> <br /> _{<b>github-actions[bot]</b>} </a> </td> <td align="center"> <a href="https://github.com/stack-file[bot]"> <img src="https://avatars.githubusercontent.com/in/408123?v=4" width="100;" alt="stack-file[bot]"/> <br /> _{<b>stack-file[bot]</b>} </a> </td> <td align="center"> <a href="https://github.com/codefactor-io[bot]"> <img src="https://avatars.githubusercontent.com/in/25603?v=4" width="100;" alt="codefactor-io[bot]"/> <br /> _{<b>codefactor-io[bot]</b>} </a> </td> <td align="center"> <a href="https://github.com/snyk-bot"> <img src="https://avatars.githubusercontent.com/u/19733683?v=4" width="100;" alt="snyk-bot"/> <br /> _{<b>Snyk bot</b>} </a> </td> </tr> <tbody> </table>