API Documentation



API

For integration and automation, ion-SMP has a web API that exposes all functionality you have access to in the main user interface.

Main ion-SMP API 1.0

The starting endpoint of the main API for production is https://production.ion-smp.net/api/smp/1.0/

The starting endpoint of the main API for testing is https://test.ion-smp.net/api/smp/1.0/

You can create an API key when you go to the account settings page after logging in, note that while main user accounts and passwords are automatically synchronized between the production and the test instances, API keys are not, so you may need to log in to both to generate separate API keys.

Full API documenation (Redoc)

We provide a full API description in the form of an openapi specification. We also have a Redoc frontend that contains the documentation for the API. It is available here:

Redoc frontend for our API documentation.

Authentication

Your API key can be used as the token in the standard HTTP Authentication header:

Authentication: Token <API key>

Note that you can use separate token for each of the users of your organization.