API

BOMIST can launch a local web server that exposes a REST API. Through this API you can then retrieve and process your workspace's data the way you want by creating your own scripts. This is great way to integrate BOMIST with your own systems.

The API can be enabled/disabled through Settings - API.

Once the server is running, you can test it by simply opening your web browser at http://localhost:3333. You should get something like this:

{
  "bomist": {
    "version": "2.1.4",
    "user": {
      "email": "user-email"
    },
    "workspace": {
      "team": false,
      "name": "Sample"
    }
  },
  "documentation": "http://localhost:3333/_swagger"
}

Documentation

The web server not only serves the API but also its documentation using a Swagger UI. Documentation is accessible at http://localhost:3333/_swagger.

Endpoints to retrieve data and to interact with the UI are available.