REST API Documentation

Part of REST API Documentation (v0.1.0) last public on August 5, 2023 at 12:00 AM UTC. You may see previous version(s) of the zone.

To maximize the compatibility of different servers and clients, this REST API documentation must be followed by the implementors or developers of the said software programs.

Prerequisites

Readers of REST API documentation are assumed to have read the functional specifications.

Documentation Parts

The documentation is divided on into several parts which are categories of different kinds of routes. It does not dictate which route to implement first. Implementors are free to support any route at any development stage if they could.

• Miscellaneous routes. Documents the routes usually supported first.
• Platform routes. Documents the routes to perform CRUD operations on the platforms tracked by the Kotovaulo system.
• Intraplatform credential routes. Documents the routes and expected internal operations for the security of intraplatform credentials.
• Interplatform credential routes. Documents the routes to perform CRUD operations on the interplatform credentials tracked.

Previous versions

There are no previous versions yet. Check back in the future.