REST API

The API is built on Express.js, uses MongoDB and fully covered by unit and functional tests that sweeps Matrix functionalities too.

You may create multiple users that will use two-factor authentication for accessing and managing the Matrix. There are available three roles: owner that is able to manage user accounts and whole Matrix, manager that can do everything with droplets and a viewer, available for checking the list and statuses of droplets.

API

The specifications and available endpoints listed in the documentation.

Deployment

Read the instructions for deploying the API to new or existing matrix.

Local development

The API is implemented as a separate project and its documentation for testing and further development available here.

Future plans

As the next step, CIKit will get the React application that will use the API and allow everyone to manage the Matrix via nice’n’fast user interface from a desktop or a smartphone.