Quick Start

Set up your environment and create your first transaction for Oracle Blockchain Platform using the REST API by performing the following tasks.

Obtain Account Information

From your account administrator, obtain the appropriate account credentials to enable you to query and invoke chaincode functions. Specifically, you will need:
  • Username and password
  • The Service URL of your Oracle Blockchain Platform instance, which is listed in the welcome e-mail you receive with your trial or purchased subscription.

Once you have your account information, you can create a REST call using cURL.

Execute a REST API Call Using cURL

The examples within this document use the cURL command-line tool to demonstrate how to access the Oracle Blockchain Platform REST API.

Step 1: Install cURL
The following procedure demonstrates how to install cURL on a Windows 64-bit system.
  1. In your browser, navigate to the cURL home page at http://curl.haxx.se and click Download in the left navigation menu.
  2. On the cURL Releases and Downloads page, locate the SSL-enabled version of the cURL software that corresponds to your operating system, click the link to download the ZIP file, and install the software.

For more information about using cURL, see cURL Access.

To connect securely to the server, you must install a version of cURL that supports SSL. You must also be granted the correct user role in Oracle Cloud Infrastructure Identity and Access Management. For more information about authentication, see Authentication.

Step 2: Understand the format of resource URLs

In order to use the REST APIs, you need to determine the URL for your instance.

The structure of the REST URL requests is described in Send Requests

Step 3: Execute your first REST API call using cURL
Use a cURL command similar to the following to return the version number of the Oracle Blockchain Platform you are using:
curl -u <username>:<password>\
 -X GET\
 https://<rest_server_url:port>/restproxy/api/version