OST KIT Mainnet Alpha 1 hosts RESTful APIs to help you manage your token economy on the OpenST utility blockchain. It introduces
user is an object that owns a branded token balance on the utility chain. The end-user can exchange branded tokens with other users or your company through interactions within your application. Users on OST KIT Mainnet Alpha 1 should be created for test purposes only. No real user data should be used in this release.
You can set up
actions to define advanced payments to tokenize your application. An action is of a certain kind:
company_to_user. The amount of the actions is set in branded tokens ($BT) or in fiat ($USD). For fiat payments, a price oracle is consulted on-chain to calculate the equivalent amount of branded tokens to transfer. Lastly, for user-to-user payments, the company can set a transaction fee.
When you create a new
user through the API, an
id is returned that represents the user object. The user id can be provided in requests to interact with the users when executing action.
Creating, editing and listing API endpoints
|Create a User||Create an Action|
|Update a User||Update an Action|
|List Users||List Actions|
|Retrieve a User||Retrieve an Action|
Transactions - Executing Actions
|Execute an Action|
|Retrieve a Transaction|
Awarding airdrop tokens to users
To incentivize new or existing users, you can airdrop tokens to get them started in the economy. Airdropped tokens remain under ownership of the company, but the user has them available to spend within the application under token rules. Airdropped tokens cannot be redeemed for OST before they have been spent (at least once) within the economy.
|Execute an Airdrop|
|Retrieve an Airdrop|
Setting up a basic wallet
To create an interface for your users to view their balances and transactions and analyze their interactions and the rewards you can use the following set of APIs along with a few others mentioned in this page.
|Fetch User's Balance|
|List User's transactions|
NOTE: In OST KIT Mainnet Alpha 1, users are represented by managed accounts for the created users i.e. OST KIT stores the encrypted private keys. Any of the APIs do not support key-management, signing of transactions or buy-in and cash-out at this point in time. In the future, we will support an on-chain decentralised key management solution to keep end-users self-sovereign owners of their tokens while allowing easy and secure integration of transfers within the application.
Fetching branded token details
last updated 3rd September 2018; for support see help.ost.com
OST KIT Mainnet Alpha 1 | OpenST Platform v0.9.2