https://github.com/fiskaltrust/middleware-demo-postman

A Postman collection containing examples that demonstrate how to call the fiskaltrust.Middleware via HTTP.
https://github.com/fiskaltrust/middleware-demo-postman

demo-application http kassensichv middleware pos-systems postman-collection rksv

Last synced: 6 months ago
JSON representation

A Postman collection containing examples that demonstrate how to call the fiskaltrust.Middleware via HTTP.

Host: GitHub
URL: https://github.com/fiskaltrust/middleware-demo-postman
Owner: fiskaltrust
License: mit
Created: 2020-05-09T15:24:55.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2023-08-18T11:23:21.000Z (almost 3 years ago)
Last Synced: 2025-01-24T17:45:13.978Z (over 1 year ago)
Topics: demo-application, http, kassensichv, middleware, pos-systems, postman-collection, rksv
Homepage: https://docs.fiskaltrust.cloud
Size: 177 KB
Stars: 3
Watchers: 6
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# fiskaltrust.Middleware demo (Postman collection)
A Postman collection containing examples that demonstrate how to call the fiskaltrust.Middleware via HTTP.

[![Run in Postman](https://run.pstmn.io/button.svg)](https://middleware-samples.docs.fiskaltrust.cloud/)

## Getting Started

### Prerequisites
In order to use this demo collection, the following prerequisites are required:
- *Postman with the imported collection*: [Download Postman](https://www.postman.com/), an API testing tool, and install it on your machine. Then click on "Run in Postman" on the [middleware API docs](https://middleware-samples.docs.fiskaltrust.cloud/) to import the collection.
- *The fiskaltrust.Middleware* running on your machine, which can be configured and downloaded via the fiskaltrust.Portal ([AT](https://portal.fiskaltrust.at), [DE](https://portal.fiskaltrust.de), [FR](https://portal.fiskaltrust.fr)). Start it (either by running it as a service, or with the `test.cmd` file), and let it run in the background to handle your requests.
- *Your Cashbox Id* is visible in the portal. It is also displayed in the startup console log of the Middleware.

### Executing the demo requests
After importing the Postman collection, you first need to set the required variables:
- Right-click on the collection and select _Edit_
- Open the _Variables_ tab, and enter the values for `cashbox_id` and `base_url`
- **cashbox_id** is a GUID and shown either in the Portal or in the log of the Middleware itself
- **base_url** is the URL of the Middleware's HTTP endpoint, **without a trailing slash**. This could e.g. look like this: `http://localhost:1500/bda7742e-fb7e-4eb6-b3ee-27e0c48fc316`. Again, this URL is both displayed in the Portal and in the Middleware log.

After you configured these two variables, you can easily run the examples by double-clicking them in the "Collections" menu.

For more information about how to use Postman collections, please refer to [their extensive documentation](https://learning.postman.com/docs/postman/collections/intro-to-collections/).

## Documentation
The full documentation for the interface can be found on https://docs.fiskaltrust.cloud. It is actively maintained and developed in our [interface-doc repository](https://github.com/fiskaltrust/interface-doc).

More information is also available after logging into the portal with a user that has the _PosCreator_ role assigned.

### Communication
The fiskaltrust.Middleware supports different communication protocols, effectively giving our customers the possibility to use it on all platforms. Hence, different protocols are recommended for different platforms. Given that HTTP is one of the most generally used network communication protocols, it should be supported on all required platforms. Please have a look into our other demo repositories for alternatives, e.g. via gRPC or SOAP.

#### User specific protocols
With the helper topology, it is possible to solve every scenario. Please contact our support if you required assistance for a special case scenario.

## Contributions
We welcome all kinds of contributions and feedback, e.g. via Issues or Pull Requests.

## Related resources
Our latest samples are available for the following programming languages and tools: