TODO: Rename to “Ring0”

This API section describes endpoints that is used in our Dashboard. You are free to build any system on top of it. All main interaction rules are the same for consumer and application API.

Main difference is in Authorization and Authentication flows.

Authorization

To use this API you need to use token with a application scope. You can receive it in /oAuth/basic endpoint.

TODO

Application token

(TODO: Describe root authentication with OTP token. Lets call them Managers + API for manager login.)

(TODO: Allow creating root user accounts only from our domain.)

Sign Up

Sign In

Projects

To start using our application you need to create a project. Project is a special scope that stores all data in it. It allows you to separate different accounts between different access scopes.

For example it can be used for eWallet white-labels, where each app have all data in separate.

All accounts already have a bootstrapped project for a development purposes.

Get all Project Settings

Changing Project Settings

You are free to attach metadata object to settings.

Create a Project

Disable Project

Delete a Project (scheduled)

Generate new API token for a Project

Delete an API token for a Project

Settings

(TODO: General authorization flow, to access to Projects list).

Transfers between Projects

Generate a new Master Token

Backups

Download all data

You can download all data of your Accounts, Tranfers, Holds and Fundings whenever you want.

Data is available in a ZIP archive with a JSON files that represent your project. There are single endpoint to download all projects. Each of them will be in a separate folder.

GET /v1/backup