overledger-apis
Service icon

Overledger APIs

Stable version 1.0.3 (Compatible with OutSystems 11)
Uploaded
 on 05 December 2023
 by 
QUANT NETWORK LTD
5.0
 (1 rating)
overledger-apis

Overledger APIs

Documentation
1.0.0

Before we can use this OutSystems forge module we need to create an account with Quant by heading to http://connect.quant.network and registering. You can access all of Overledgers functionality for two testnets with our free trial account.

A screenshot of a login form

Description automatically generated

A screenshot of a computer

Description automatically generated



A screenshot of a computer

Description automatically generatedOnce registered create an application by going to My Applications 

Be sure to enable your applications for testnet signing 

A screenshot of a computer application

Description automatically generated 

 

Follow the steps and have your application details generated and added to your Connect account. 

Note: You can access your application details at any time by clicking on the eye icon under actions 

A screenshot of a computer

Description automatically generated 

 

Note: You will need to fund the key generated in your application with some testnet currency before you can sign transactions in through Overledger. Copy the transaction signing key id and head over to any faucet compatible with your chosen network to receive tokens 

Next head to the OutSystems service Studio app and create your first application, for the sake of this documentation we’ll create a webApp application. 

 

 

Now we can download the module and add it as a dependency to our web app application. then we need to configure the module in order to use and interact with the Overldeger APIs. in the Overledger APIs module head to the Data tab and edit the Site Properties with the values you’ve got from the Quant platform. The details can be found in the more details section of your application in the My Applications if you need to refer to them.  

 

  1. ClientId: Your Application ClientId 

  1. Secret: Your Application Client Secret 

  1. KeyId: Your Application KeyId which is your Transaction signing Key ID 

  1. tsrName: Your Applications TSR name which is your Transaction signing name

  2. tsrPublicKey: Your Application Transaction signing public key. if it’s in a PEM formatted public key you need to convert it to an XML format, RSA PEM TO XML - RSAKeyConverter 

  3. OverledgerSandboxURL: Overledger Environment you have access to (for sandbox would be https://api.sandbox.overledger.io) 

  4. OverledgerAuthURL: Overledger Authentication user-pool you have access to (for sandbox would be https://auth.overledger.io) 

A screenshot of a computer

Description automatically generated 

 

 

We can now head back to our web app application and add the Overledger APIs module as a dependency to our app and choose the Server actions we want to use in our app shown below: 

A screenshot of a computer

Description automatically generated 

Now that we have configured our module we can start implementing our UI logic and use Overledger APIs to interact with the desired network. 

A screenshot of a computer

Description automatically generated 

Shape  

and we can use the previously added server action in the SaveOnClick client action 

 

A screenshot of a computer

Description automatically generated 

 

You can find more information on the APIs and their uses here https://quant.network/overledger-platform/developer-documentation/