About
APIs are crucial part of any IoT system, and sepioo® is not an exception. sepioo® uses REST APIs to operate the platform. PDi Digital provides easy access and management of publicly available APIs related to sepioo. sepioo® Cloud and sepioo® On-Premise require a different approach to access the available API calls.
API IP address
The API IP address is static and will not change. This may be necessary for firewall rules.
The IP address is 52.174.194.74
Accessing the API - sepioo Cloud
You can find all your subscriptions and their keys in your profile. Click on your name and select “PROFILE”.
To use the API, click on “API” and select the correct environment. On the left side you will see all API endpoints. On the right side you can test the selected endpoint directly. Each API call requires the route parameter “account” (find your account name here).
Anything that can be done in the sepioo® User Interface of the Control Center can also be done through the API. You can access the API portal here: API-Portal
After navigating to the API portal, click on “SIGN IN” in the top right corner. The login credentials are the same as in the sepioo® Platform.
The first thing you need to do is subscribe to a product. This option is available by clicking on “PRODUCTS” and selecting the environment for which API keys are required. This will open another window where the subscription can be named and submitted.
Once submitted, it will take some time for it to be approved and the user will be notified via email associated with the account used to log in to the API portal once it is approved.
A user can have multiple subscriptions for each environment, but each subscription, and thus each set of API keys, is associated with the same account.
If for some reason a complete separation of multiple API subscriptions is required, a different unique user is required for each of them. This would mean that each separate account (associated with a different company) would need its own unique user to log in to the API portal and submit a subscription request.
All the active subscriptions can be found by accessing any of the active subscriptions for the account that is currently signed in. From this dashboard, you can copy and paste keys where needed, manage subscriptions, and even close accounts.
API calls list and details
Opening the APIs page and selecting the Environment will open an interface where all the sepioo® API Calls can be found, along with the option to send them directly through this interface or to get the URLs and all the other information needed if the calls want to be tested by 3rd party API software (like Postman).
Downloading the API call list
On the same page, in the upper right corner, there is a button “API Definition” which allows any user to download the complete documentation of all API calls, available in several formats.
This can be used to access all technical details about the calls used in sepioo®.
This also gives any user the option to import the calls into a 3rd party program like Postman and use the API calls that way.
Accessing the API - sepioo On Premise
The API documentation for sepioo on-premise is accessible from any web browser. To access it, navigate to the installed web application and add “/swagger” to the URL.
It can look like this: https://<ip adress of the local machine that is running sepioo>/swagger
Or it can be accessed this way: http://localhost/swagger/index.html
