REST API methods available to smart contracts

Important

REST API methods for Docker smart contracts are are being phased out.

Docker container-based smart contracts can use the node REST API. For a general tutorial on how to create smart contracts using the REST API, see the article Docker smart contracts with the use of the node REST API.

Not all REST API methods are available to Docker smart contract developers. Below is a list of REST API node methods that a smart contract can use directly from the Docker container.

‘Addresses’ methods

• GET /addresses

• GET /addresses/publicKey/{publicKey}

• GET /addresses/balance/{address}

• GET /addresses/data/{address}

• GET /addresses/data/{address}/{key}

‘Crypto’ methods

• POST /crypto/encryptCommon

• POST /crypto/encryptSeparate

• POST /crypto/decrypt

‘Privacy’ methods

• GET /privacy/{policy-id}/getData/{policy-item-hash}

• GET /privacy/{policy-id}/getInfo/{policy-item-hash}

• GET /privacy/{policy-id}/hashes

• GET /privacy/{policy-id}/recipients

‘Transactions’ methods

• GET /transactions/info/{id}

• GET /transactions/address/{address}/limit/{limit}

‘Contracts’ methods

In order to enhance performance, a smart contract can use the Contracts methods via a dedicated /internal/contracts/ route, that are fully identical to the plain Contracts methods.

• GET /internal/contracts/{contractId}/{key}

• GET /internal/contracts/executed-tx-for/{id}

• GET /internal/contracts/{contractId}

• GET /internal/contracts

PKI methods

• PKI /verify

Authorization of a Docker smart contract

In order to work with the node REST API, a smart contract requires authorization. To ensure a correct interaction of a Docker contract with the API methods, following actions should be performed:

1. Define following variables as environment variables of a Docker contract:

• NODE_API - URL to the node REST API.

• API_TOKEN - Docker contract authorization token.

• COMMAND - commands for creation and call of a Docker contract.

• TX - transaction required by a Docker contract for work (codes 103 - 107).

2. A Docker contract developer assigns an API_TOKEN value to the header of the X-Contract-Api-Token request. Node writes to the API_TOKEN variable a JWT authorization token during creation and execution of a contract.

3. A contract code should transfer a received token in the header of the (X-Contract-Api-Token) request in every access to the node API.

Was this page helpful?

Yes No