Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

corrected typos and improved readability appendix-fr communication #155

Merged
merged 1 commit into from
Jan 25, 2021
Merged

corrected typos and improved readability appendix-fr communication #155

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 7 additions & 11 deletions doc/appendix-fr-boi-tva-decl-30-10-30/communication/communication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
## Communication
# Communication

### WCF Web Service

### REST Service
## REST service

The fiskaltrust.Middleware which directly implements the REST communication protocol is a product called fiskaltrust.ChaîneCloud. Communication with this service is implemented via the URL <https://signaturcloud.fiskaltrust.fr/> followed by xml/ or json/ depending on the content serialisation type, and then followed by the method name in lowercase letters (echo, sign, journal).

Depending on the serialisation type, the content-type will be "application/json;charset=utf-8" (for JSON) and "application/xml;charset=utf-8" (for XML). The method is POST and the headers must contain the "cashboxid" and the "accesstoken" with the corresponding value related to the configured cashbox on the fiskaltrust.Portal.

"Echo" call will contain the serialised message in the request content. The "sign" call will contain the serialised ReceiptRequest class in the request content. The "journal" call will have the following url query for posting the values `?type={1}&from={2}&to={3}` where type is the journal type and the other two values are limits of the timestamp values for extracting the data.
Depending on the serialisation type, the content-type will be "application/json;charset=utf-8" (for JSON) and "application/xml;charset=utf-8" (for XML). The method is POST, and the headers must contain the "cashboxid" and the "accesstoken" with the corresponding value related to the configured cashbox on the fiskaltrust.Portal.

#### REST Helper
The "Echo" call will contain the serialised message in the request content. The "sign" call will contain the serialised ReceiptRequest class in the request content. The "journal" call will have the following URL query for posting the values `?type={1}&from={2}&to={3}` where type is the journal type, and the other two values are limits of the timestamp values for extracting the data.

The REST helper implements the same REST interface as the REST service. Additionally, it includes the balancing feature of a Balancer Helper. The URL used to reach the REST Helper can be set in the fiskaltrust.Portal on the configuration page of the REST helper.
### REST helper

In addition to the two values for the balancing parameter, there is another value called "deactivated" which bypasses the balancing feature (only if there is one fiskaltrust.Middleware configured inside the cashbox, if there is more than one, this option will be ignored and used the "least active"). This new option will let the REST helper behave exactly like the REST Service for the journal calls.
The REST helper implements the same REST interface as the REST service. Additionally, it includes the balancing feature of a balancer helper. The URL used to reach the REST helper can be set in the fiskaltrust.Portal on the configuration page of the REST helper.

### Stream for Serial Interface over TCP
In addition to the two values for the balancing parameter, there is another value called "deactivated" which bypasses the balancing feature (only if there is one fiskaltrust.Middleware configured inside the cashbox, if there is more than one, this option will be ignored and used the "least active"). This new option will let the REST helper behave exactly like the REST service for the journal calls.