Common API Usage (Important !)
- Home
- Quick Start
- Common API Usage (Important !)
- FST Engine API utilises GraphQL to make complex data-integrations agiler, type-safer and clearer
- Please check and try immediately in your FST Engine GraphQL Playground provided by FST Network
- Please don’t forget to set
Authorization
http header via Auth before performing the operations that need to be authorised (also in GraphQL Playground) - There are 3 common types of APIs in FST Engine:
READ
,CREATE
andTRANSACT
READ
indicates that the operation reads data from Accountable Data Network (FST DataRail)CREATE
indicates that the operation creates data (e.g. Smart Contracts, Ledgers) to Accountable Data Network (FST DataRail)TRANSACT
indicates that the operation updates data to Accountable Data Network (FST DataRail)
- The APIs in
CREATE
type andTRANSACT
type mostly require the Transaction Signing process with the API response- Please see more details at signTransactionExample
- As for
READ
API, the pagination in this type of API follows the principle of GraphQL cursor-based pagination- In short, the
pageInfo.endCursor
in the response for current page will be theafter
in next page API call. And thefirst
is equal to thelimit
in common databases usage
- In short, the
Copyright © 2018-2019 FST Network Ltd., all rights reserved.