Before body

Home
Sensolus platform
Learn how the platform can deliver business insights and how you can configure it
API Integration
All explanation on how to integrate with the Sensolus platform.
Pull API

Getting started
Get started with the Sensolus solution
Sensolus platform
Learn how the platform can deliver business insights and how you can configure it
- Platform navigation
- Asset management
  Learn how to manage and customize your assets.
- Infrastructure management
  Learn how to manage and customize your infrastructure (for example, geobeacons or BLE zone anchors).
- Localization
  Learn how the locations of your assets are captured.
- Information on network operator used by device
  Explanation on where to find information on the network operator your device is currently using.
- Utilization
  Learn how the utilization of your asset fleet can be monitored.
- Geozones
  Learn how to optimize process flows by getting more out of the location information of your assets by using geozones.
- Flows
  Learn how to monitor the rotations of flows of your assets through the supply chain.
- Maintenance
  Learn how to keep your asset fleet maintained in a timely and optimally way.
- Environmental sensing
  Learn how to follow up the conditions of your assets beyond location and activity.
- Dashboards
  Here you can learn about the different types of dashboard on the Sensolus platform.
- Alerts and reports
  Learn how to be notified in case of anomalies in your business processes and how to extract reports with relevant data.
- Customization
  Learn about the different ways to customize the Sensolus platform to your personal preferences.
- User management
  Learn how to manage users, permissions and security.
- Partner account features
  Learn about platform features only available to Sensolus partner accounts aimed at efficiently serving your customers and managing multiple organizations.
- API Integration
  All explanation on how to integrate with the Sensolus platform.
  - Integration principles
    The integration API provides an easy way to interact in 3 different ways with the platform: perform management tasks, retrieve data from the platform with a pull or push mechanism and inject third party data into the platform
  - Pull API
    - REST API tools
  - Push API
    Explanation on the management and usage of the Push API
  - REST API (pdf)
    Description of the key principles of the integration API with the Sensolus platform, with some examples
- 3rd party integrations
  Integrations with devices or platforms and the Sensolus platform.
- General information on the platform
  Everything that is not specifically related to a service but tells you something about the general characteristics of the Sensolus platform and solution
Sensolus Mobile app
Information on the Sensolus mobile app.
Devices
Information on all Sensolus hardware devices
Release notes
Stay up to date with the new and updated features and devices and read the latest updates on our services.
Glossary
Learn to know the most important terms and keywords used on the platform

Pull API

Developer API keys

To use the Pull API, you need an API key. API keys can be obtained from your partner. You should pass the API key as a request parameter (<url>?apiKey=<your API key>) on every API request. There is a monthly limit on the amount of calls you can make with an API key. This limit is only imposed to prevent unfair usage of the system, it is not linked to your subscription plan. Consider using the push API if your integrating system depends on the real-time status of your devices.

You see the information on your API key via Admin → Developers → API access

Everyone with the API key can make calls with it, so you are supposed to keep your API key in a secure place.

It is possible to limit API calls to a specific subset only to avaoid quotat theft.

API documentation

After obtaining an API key, the API documentation and Swagger UI will become available.

Do as following to start working with it:

Go to Admin → Developers → API docs
Click on an operation to open the try-out panel (for example: GET /API/v2/alertRules to get all the alert rules.
The following panel will open

This shows the parameters, response codes and JSON schema descriptions for the request and response bodies. To try out the call, click the Try out button.
The REST call will be executed and you will see the actual response.
A curl command is shown for command-line usage and, in case of a GET command, you may also see a download button to save the response.