Introduction

What are the Transactions?

The concept of transactions was created for the purpose of representing customer-side document production processes. In a single transaction, it is possible to produce one or more documents representing a single process, such as a contract termination, a credit application, an invoice, etc.

Adding an abstract object such as a Transaction allows you to simplify the client-side integration logic at the code level. Simply sending Transaction Data Record (defined by a predefined Data Stream) is enough to produce a set of documents.

Transactions also correspond with the definition of transactionality in the sens of database transactions, i.e. they are atomic operations that will either be executed in full or not executed at all. If an error occurs during document creation, the transaction will be rolled back and the documents will not be produced. When using a classic atomic REST API, the client would have to provide this functionality on its own.

The Transaction Record sent to the Pergamin system should contain all the necessary data for the production of one or more documents within the entire process on the client side. The structure of the Transaction Record is defined by the Data Type, and the mapping of the record's fields onto input of templates or PDF documents is defined by the Data Stream.

Przesyłany do systemu Pergamin rekord transakcji powinien zawierać wszystkie niezbędne dane do wytworzenia jednego lub wielu dokumentów w ramach całego procesu po stronie klienta. Strukturę rekordu transakcji określa [Data Type], a mapowanie pól rekordu na dane wejściowe do szablonów/dokumentów PDF definiuje [Data Stream].

Appropriate configuration of the Data Type and Data Stream allows the transaction to send a signature queue definition for the documents being produced, and to send PDF documents instead of input for templates.

T-API also provides Webhook functionality, which allows to notify client application about any document status changes.