Developers LinkApi

The Linkapi Developer Hub

Welcome to the Linkapi developer hub. You'll find comprehensive guides and documentation to help you start working with Doc Linkapi as quickly as possible, as well as support if you get stuck. Let's jump right in!

Transactions

These are our SDK Transactions.

Command(parameters)
Description

linkapi.transaction.start(id)

Start a transaction with PENDING status, receiving the attribute that will be used as the transaction identification.

linkapi.transaction.success(id)

Close a transaction with the parameter id imputed and change its status from PENDING to SUCCESS.

linkapi.transaction.failed(id)

Close a transaction with the parameter id imputed and change its status from PENDING to ERROR.

linkapi.transaction.empty(id)

Close a transaction with the parameter id imputed and change its status from PENDING to EMPTY.

linkapi.transaction.trace(id, obj)

Create an event log inside a transaction with the PENDING status. Input the transaction id and an object as a parameter. That object must have the properties ‘name’ (will contain the log’s name), ‘data’ (will keep its content) and ‘status’ (which can be SUCCESS, ERROR or EMPTY).

linkapi.transaction.validate(id)

Check if the id already has a transaction completed with success. If yes, will be returned ‘true’, otherwise, ‘false’.

In LinkApi platform, all Transaction information will be under Monitoring > Transactions. You can filter them by id, date or status.

All trace information can be found inside View logs, including successes, errors and payload logs.

Was this article useful?