You can connect eKasa to your software in two ways: via the HTTP API or as a .NET library. Both use the same certified program, so receipts, printing and results are the same. They differ in where eKasa runs and how you call it. We recommend the HTTP API.
Comparison
| HTTP API | .NET library | |
|---|---|---|
| Programming language | any (PHP, Java, JavaScript, Python, C#…) | .NET (C#, VB.NET, F#) |
| Platforms | Windows, macOS, Linux, Android | Windows, macOS, Linux |
| Where eKasa runs | as a separate service (an app on Android); your software calls it over the network | directly inside your application |
| Updating eKasa | install a new version of the service; your software stays as it is | release a new version of your application with a newer NuGet package |
| Several applications in one place | all of them can call the same service | only one process may use the CHDÚ storage |
| Software in the cloud or a browser | yes, via Expose built into eKasa, a VPN or another reverse proxy (see Access from the internet) | no, the application must run next to the storage |
| Settings and initialization package | the service’s web interface (WebAdmin) | the Portos eKasa Servis app (Windows) or your own UI |
When to choose the HTTP API
We recommend the HTTP API, even if your software is written in .NET. eKasa runs as a separate service next to your software, so:
- Less responsibility on your side. The service, not your application, takes care of the CHDÚ storage, printing, the offline queue and eKasa updates.
- Separate runtime. eKasa has its own runtime and process. A crash or update of your application does not affect it, and vice versa.
- Easier support. The boundary between your software and eKasa is clear: a request and a response. Service logs and status are in the web interface, so together we quickly find where a problem lies.
- Independent updates. You update eKasa without releasing a new version of your application.
- All platforms and deployments. It works on Android (tablet, kiosk, payment terminal), for software in the cloud, in a browser or on another device in the network, and for several applications at one site.
For PHP there is an open-source HTTP API client library under the MIT licence (Packagist, GitHub). It works with a local connection as well as via Expose.
When to choose the .NET library
Choose the library if you develop a desktop application in .NET and cannot or do not want to install and manage a separate service at the point of sale. eKasa then runs inside your process, and you take care of running it, updating it and accessing the storage.
The NineDigit.eKasa library is on nuget.org. It is built for
.NET Standard 2.0, .NET 6, .NET 9 and .NET 10, so it also works on .NET Framework 4.6.1 and newer (we recommend 4.7.2).
The library communicates with the CHDÚ storage exclusively. Your application should therefore keep a single client instance for its whole lifetime, and no other process may use the storage at the same time. Details are in Library instantiation.