API Access for seamless sharing of READy data with other systems

What is API Access?

Kamstrup API Access provides a secure way for READy to share data with other systems, such as customer portals, GIS, or SCADA. This enables the creation of a digital ecosystem where information from different systems is shared, allowing you to improve your customer service and optimise operations and existing workflows.

API Access is an add-on to READy for those who wish to transfer data easily and securely between their systems. API Access is available to existing Kamstrup-hosted READy customers. It cannot be offered to local READy installations. You continue to have the features in READy you already know, while API Access creates a more fluid information delivery and an integrated user experience when you use READy.

Kamstrup provides a safe way for utilities and third-party developers to develop and test requests through API Access by offering a testing environment we call a sandbox. With this option, it is possible to make the integration and application robust before introducing it into production.

What is an API?

An application programming interface (or API) is code that functions as a bridge between different systems – often from different suppliers, which allows two or more systems to communicate and share data regardless of their underlying architectures or technologies.

Comparing API Access to READy export feature. What’s the difference?

In the following, we have highlighted key differences so you can compare the features of API Access to the READy export feature. When you integrate Kamstrup API Access, you continue to have the READy export feature – you just add more options and allow for more efficient transfer of data and greater control when working with meter data.

READy export feature

READy API Access

Rule-based data export

With the export feature built into READy Manager, you need to declare whether your data should be exported hourly, daily, weekly, or monthly. Export will then happen in a fixed export schedule, with the lowest frequency setting being hourly.

Event-based data export

With the API Access add-on to READy Manager, you set up data to be transferred automatically when certain events happen or when the data is ready in READy rather than adhering to a fixed export schedule.

Delayed alarms

Although alarms (info codes) will be present in READy shortly after being triggered in the physical meter, you will either have to check READy manually to be informed of them or wait for the export of the alarms, which will not take place until the next scheduled export.

Timely alarms

You can subscribe to alarms (info codes) when API Access is integrated into READy Manager. This means that as soon as there is an alarm in READy, you receive a notification, and the information will be available through API Access.

One-way data export

The READy export feature serves only one purpose: to extract data from READy and make it available outside READy Manager. Importing information into READy with the READy export feature is not possible.

Two-way data synchronisation

API Access transfers data from READy to other systems, but it also allows other systems to send changes to groups, installation points, and meters back to READy.

Standard data protection

Data exported via the built-in export feature in READy Manager is exported to an SFTP server, FTP server, or email. Common for these destinations is that they are typically protected by a username and a password.

Advanced data protection

To transfer data via API Access, you need a valid OAuth2 access token which requires three inputs: A client ID, a tenant ID, and a client secret. Additionally, data is encrypted, and if you use the webhooks/subscription function of API Access, an active API key from READy Manager is also needed.

API Access for developers: How does API Access work?

Kamstrup API Access is code which governs access points for the READy server. It works in two ways: As a standard REST (Representational State Transfer) API, which is a web service that allows a client to make requests for resources from READy through URL paths, utilising the Hypertext Transfer Protocol (HTTP). This is similar to when you visit a regular webpage where you request a resource stored on a server, and the server responds with the requested information.

Click on Discover more below to read more about API Access.

Discover more

Apart from the regular request-response way of working, Kamstrup API Access can also work as a webhook API. With standard REST APIs, data is served upon request, making them reactive, which means that they react upon request but typically do nothing on their own without prompting from the user. On the other hand, a webhook can handle requests (such as requests to retrieve all meters) and events (such as subscribing to the latest meter readings). Event-driven means that it allows one system to send data to another as soon as a given event takes place. Both webhook and REST API respond in JSON.

From a technical standpoint, API Access enables developers to automate, extend, and combine data from devices such as meters with other systems or services while ensuring data is secure. In practice, this allows developers to create a digital ecosystem, programmatically develop apps and services, and perform other tasks which could previously only be accomplished within Kamstrup’s software suite.

To automatically integrate READy with your IT system of choice, you must have software development capabilities, as this is not part of the offer with API Access.

Kamstrup also offers the product “API Access – Development Environment”, an API sandbox where testing is possible. The sandbox permits programmers and developers to try out changes without altering anything in the live environment. It also allows third-party developers to create solutions and services. The API sandbox provides test data from approximately 5000 meters to enable developers to test new code, mimic real-life occurrences, and create simulated responses. It is a separate product from API Access and is available for utilities and third-party developers. With it, any potential bugs will be caught before implementation, which reduces the cost and risk associated with new responses.

Are you ready to begin using API Access to access data from READy and have already purchased the software?