Skip to content

Commit f503d54

Browse files
authored
Merge pull request #8 from fiskaltrust/review-content
DevKit - Reviewing content
2 parents 5b6a7e8 + f3e3b9b commit f503d54

4 files changed

Lines changed: 136 additions & 131 deletions

File tree

HOWTO_01_Payment_csharp/README.MD

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,26 @@
22

33
## Prerequisites
44

5-
Install and configure the InStore app to execute payments (see main DevKit README for further details).
5+
Install and configure the **InStore app** to execute payments. For more information, see the [Development Kit README](https://github.com/fiskaltrust/possystemapi-devkit/blob/main/README.MD).
66

7-
## What to expect when running this HOWTO
7+
## What to expect when running this How-To
88

9-
All our howtos are reusing some code that is provided as a .NET Assembly/library in source and can be found in `../libPosSystemAPI/` directory. Please check it after trying out the HOWTOs to get a better understanding what it does under the hood and how it interacts with the POS System API.
9+
All How-To's reuse code provided as a .NET assembly/library in source, which can be found in the `../libPosSystemAPI/` directory. After trying out the How-To's, reviewing this code is recommended to gain a better understanding of how it works under the hood and how it interacts with the **POS System API**.
1010

11-
The HOWTO demonstrates
11+
This How-To demonstrates the following:
1212

13-
- initial credential reading and executing an `/echo` request to know if the fiskaltrust / POS System API backend is reachable (actually done by libPosSystemAPI)
14-
- creates a `/pay` request with `action: payment`
15-
- writes the result of that request to the console
16-
- basic error handling (see next)
13+
- Initial credential reading and executing an `/echo` request to verify that the **fiskaltrust POS System API** backend is reachable (handled by `libPosSystemAPI`).
14+
- Creation of a `/pay` request with `action: payment`.
15+
- Writing the result of the request to the console.
16+
- Basic error handling as described in the following section.
1717

1818
## Errors to be handled
1919

20-
There are multiple critical issues to be handled nicely to avoid double payments or the loss of a payment.
20+
Several critical error scenarios must be managed carefully to prevent double payments or loss of a payment.
2121

22-
### We were able to send the payment request but we were not able to receive the response
22+
**Example:** A payment request is successfully sent, but the response cannot be received. Possible causes include:
2323

24-
- Because we lost internet connectivity while waiting
25-
- Because we could not get the response in time (= http timeout waiting for the response which can be simulated by a device on which the payment gets executed looses internet connectivity during operation)
26-
- ?
24+
- Internet connectivity is lost while waiting for the response.
25+
- The response is not received within the expected time frame (HTTP timeout), which can be simulated by a device losing internet connectivity during payment execution.
2726

28-
In all cases the solution is to resend the original request (with identical operation ID and request body). The backend will then return the final result.
27+
In all of these cases, the solution is to resend the original request using the identical operation ID and request body. The backend will then return the final result of the operation.
Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
1-
# HOWTO 02 - Getting started with fiskal signing in C#
1+
# HOWTO 02 - Getting started with fiscal signing in C#
22

33
## Prerequisites
44

5-
Have the POS System API + Cashbox config set up and ready to go for fiskal signing. See [fiskaltrust documentation](https://docs.fiskaltrust.cloud/) for further details.
5+
Ensure that the **POS System API** and CashBox configuration are set up and ready for fiscal signing. For more information, see the [fiskaltrust documentation](https://docs.fiskaltrust.cloud/).
66

7-
## What to expect when running this HOWTO
7+
## What to expect when running this How-To
88

9-
All our howtos are reusing some code that is provided as a .NET Assembly/library in source and can be found in `../libPosSystemAPI/` directory. Please check it after trying out the HOWTOs to get a better understanding what it does under the hood and how it interacts with the POS System API.
9+
All How-To's reuse code provided as a .NET assembly/library in source, which can be found in the `../libPosSystemAPI/` directory. After trying out the How-To's, reviewing this code is recommended to gain a better understanding of how it works under the hood and how it interacts with the **POS System API**.
1010

11-
The HOWTO demonstrates
12-
13-
- initial credential reading and executing an `/echo` request to know if the fiskaltrust / POS System API backend is reachable (actually done by libPosSystemAPI)
14-
- creates a `/sign` request to similate signing a receipt
15-
- writes the result of that request to the console
16-
- basic error handling
11+
This How-To demonstrates the following:
1712

13+
- Initial credential reading and executing an `/echo` request to verify that the **fiskaltrust POS System API** backend is reachable (handled by `libPosSystemAPI`).
14+
- Creation of a `/sign` request to simulate signing a receipt.
15+
- Writing the result of the request to the console.
16+
- Basic error handling.
Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
1-
# HOWTO 08 - Execute the 3 main actions - Payment - Sign - Issue in C#
1+
# HOWTO 08 - Executing the three main actions: Payment, Sign, and Issue in C#
22

33
## Prerequisites
44

5-
Have the POS System API + Cashbox config set up and ready to go for fiskal signing. See [fiskaltrust documentation](https://docs.fiskaltrust.cloud/) for further details.
5+
Ensure that the **POS System API** and CashBox configuration are set up and ready for fiscal signing. For more information, see the [fiskaltrust documentation](https://docs.fiskaltrust.cloud/).
66

7-
## What to expect when running this HOWTO
7+
## What to expect when running this How-To
88

9-
All our howtos are reusing some code that is provided as a .NET Assembly/library in source and can be found in `../libPosSystemAPI/` directory. Please check it after trying out the HOWTOs to get a better understanding what it does under the hood and how it interacts with the POS System API.
9+
All How-To's reuse code provided as a .NET assembly/library in source, which can be found in the `../libPosSystemAPI/` directory. After trying out the How-To's, reviewing this code is recommended to gain a better understanding of how it works under the hood and how it interacts with the **POS System API**.
1010

11-
The HOWTO demonstrates
12-
13-
- initial credential reading and executing an `/echo` request to know if the fiskaltrust / POS System API backend is reachable (actually done by libPosSystemAPI)
14-
- Creating a dummy list of charge items
15-
- Execute the following actions with ftPosAPIOperationRunner which is a helper class wrapping the retry logic
16-
- `/pay` the charge items
17-
- Generate the receipt info with `/sign`
18-
- Deliver the receipt to the user via `/issue`
19-
- Wait for receipt delivered status
11+
This How-To demonstrates the following:
2012

13+
- Initial credential reading and executing an `/echo` request to verify that the **fiskaltrust POS System API** backend is reachable (handled by `libPosSystemAPI`).
14+
- Creation of a dummy list of charge items.
15+
- Executing the following actions using `ftPosAPIOperationRunner`, which is a helper class that wraps the retry logic:
16+
- `/pay` the charge items.
17+
- Generate the receipt information using `/sign`.
18+
- Deliver the receipt to the user via `/issue`.
19+
- Waiting for the receipt delivered status.

0 commit comments

Comments
 (0)