OPEN Platform API Documentation Overview

Hello OPEN Community, 

Given our recent developer engagement initiatives, we would like to provide community members with an overview of our various and extensive Open Platform Documentation resources to help and encourage developers to contribute to our ecosystem. In this update, we want to highlight the Open Platform API Documentation to help developers engage with the completed technologies available for use. 

The Open Platform API allows developers to deploy payment scaffolds and integrate cryptocurrency payment gateways in both their centralized and decentralized applications in a way that abstracts away complexities of the development process. Scaffolds allow for any on-chain activity to sync with application databases off-chain, updating aspects such as payment data and user access. 

Developers can start leveraging our easy-to-use API to build powerful applications by referring to the Open Platform API Documentation. The Open Platform API Documentation describes all the endpoints (URL paths) the API supports, the operations (request types) that can be performed with those endpoints, as well as the resource data that is returned.

In more technical terms, Open Platform provides an API that can be used to create, retrieve, update and delete all the resources stored and manipulated by the system. This is possible thanks to making HTTP requests transfer JSON-encapsulated data. This interface incorporates several elements of the REST tradition to facilitate access to the above-mentioned actions. All API requests have to be authenticated with credentials for a specific Open Platform user, on whose behalf the request is being made. 

Currently, credentials represent themselves as single per-user API Tokens that can be obtained by users on their personal Key Management page. Endpoints are united in groups with other related endpoints in accordance with a logical reading order. Each example of a provided endpoint not only shows the curl command to create the request but also contains the server response. The response data is intended for being typical of a realistic example, rather than a comprehensive one.

Below are the different sections of the Open Platform API Documentation: 

User API

This section contains the work with users which allows developers to get basic information about the user that is currently using the system such as current balance amounts and user ID.

OpenKey API

This section contains the work with Open keys. Each developer can generate new tokens and has an opportunity to study available keys with information on expiration date. Also, a developer has an option to disable a given Open key.

Transaction API

While performing any method of a smart contract, Open Platform catches the corresponding event. This section provides descriptions of all the available types of Scaffold events and endpoints for retrieving all Scaffold transactions. Each transaction includes basic information about the current state of a Scaffold contract, the event, as well as the type of a transaction.

Scaffold API

This section provides the main functionality needed for working with Scaffold smart contracts. The developer is able to compile and deploy a Scaffold as well as track the current state of these contracts. Open Platform has a limit on the maximum possible amount of deactivated scaffolds. The limit is approved at the mark of 10 scaffolds. Furthermore, a developer has the option to get a webhook with a view to receiving Scaffold changes.

Scaffold Templates API

This section provides information about Scaffold templates. They are needed to show the required fields for creating contracts.

Share Holder API

This section contains the interaction with shareholders of Scaffold smart contracts. It allows developers to add, update, or remove shareholders. A share is paid after a customer pays the Scaffold.

Errors

If an error occurs while an API request is being processed, the error data will be fully provided. These data will include information regarding the status of the failure, its description and the list of errors with the indication of codes and failure fields (optional). This section contains the data structure of error responses and their statuses.

Scaffold Versions

Open Platform provides an opportunity to manage different Scaffold smart contracts versions. This section contains information about the differences between the supported versions.

Please stay tuned for more documentation updates in the future!