Introduction

The permissions required to access certain endpoints vary depending on the nature of the endpoints. Some endpoints do not require any permissions at all, while others require your authoirzation token or access key to have been granted specific permissions. For more information on the types of permissions, please visit Types of Permissions.

Responses from requests are in JSON format. The response will also contain the HTTP status code, which will indicate whether the request has been succesfully completed.

The BigLedger database uses PostgreSQL and is made up of several different modules. Details on the structure of the database can be found in our DB Schema.

The BigLedger API and database has been split into a root and a tenant module. Requests made to the tenant module require the tenantCode to be provided in the HTTP headers. To learn more about the differences between the two modules, please visit Root vs Tenant DB.

There are 3 environments used by BigLedger: Development, Staging and Production. During the SDLC, programmers will need to wait for their enhancements to be deployed to Development and Staging for internal/external testing before they can be deployed to Production. More information about the different environments and how to deploy to these environments can be found in Deployment of API to Production Staging and Development.