Using the Platform API

Anne Rosebery

The platform API is available within the reference docs inside your platform instance at a URL like:
<your server>/app/dev/docs/api
so if your kinops server is
https://mycompany.kinops.io
the API would be available at
https://mycompany.kinops.io/app/dev/docs/api

This gives the same endpoint information that is avialable here for the API, but is also an active, interactive API. This gives the ability to run each endpoint as the person you are logged in as.

Tips and Pointers

For each endpoint there are generally the following endpoints:

GET (for all of the item and for a specific one) POST (create) PUT (update) DELETE (delete)

Note that though you can retreive an item en-masse, all of the other functions are for one at a time. This means though you can export all bridge models at once, you can only import or delete them one at a time via this interface. If you want to import en-masse, you can write a script to do so. The SDK is created to make this even simpler.

Each endpoint has examples of exactly what format it expects, what includes are available, and what format you can expect the data to be in in the documentation. These are good ways to double check yourself.

Delete and update require confirmation via checkbox before the button to use the endpoint becomes active. This is to help prevent accidents, since this is a live interface in the space the documentation is for and will actually delete or update live records.