overledger-sdks

This github repository provides different language SDKs, which can be found in the SDK folder, for the Overledger DLT API Gateway.

How To Use

The SDK packages provide functions for interacting with Overledger according to the manner detailed in the OpenAPI3 documents in this folder. A UI version of these documents can be found here.

To use the SDKs with Overledger, you will need an Overledger client ID and client secret, which are generated via the Overledger Developer Portal.

SDK Regeneration Process

When Overledger's APIs are extended, the SDKs will need to be regenerated to make use of the new Overledger features. Before regeneration, make sure that your openAPI3 documents are updated in this folder. Pay particular attention to the token url in the security scheme section and the url in the servers section, to make sure that they point to the correct mainnet or testnet instance of Overledger.

The SDKs are automatically generated from the Overledger OpenAPI3 Document via:

npm run generate-{mainnet,testnet}-sdk-{c#,c,go,haskell,java,javascript,kotlin,perl,php,ruby,rust,typescript-axios}

For a full set of available scripts see this package.json.