Water
Heat
Data security
Data reliability
Meter data management (MDM)
Your selected documentation ()

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.
  • 5 reasons to integrate API Access with READy today

5 reasons to integrate API Access with READy today

 

Explore the benefits of API Access. When you integrate the software solution with READy, you gain new features and benefits without losing the features you already know from READy.

  • 1. Automate access to READy data
    API Access provides a fast, flexible, and cost-effective way of automatically integrating READy data from Kamstrup meters with other systems regardless of their underlying architectures. It lets you build a digital ecosystem and share data across your different platforms. API Access supports many users and requests, and because of the software architecture, the system can grow with you and your needs.
  • 2. Reduce manual processes
    API Access enables software developers to automate various tasks and processes across systems and applications, such as GIS or SCADA. It can also help improve, for instance, billing workflows as computers rather than people perform tasks, which lets you achieve more efficient and effective workflows while also reducing manual errors and cutting costs.
  • 3. Stay up to date
    Stay up to date on smart meter reading data with API Access. It lets you subscribe to data from READy and collect data on demand. Have the newest data as soon as it is available, as the API guarantees automatic and instant synchronisation between systems and notifies you about new data.
  • 4. Keep your data secure
    Security is a top priority with API Access. Due to its underlying architecture, an API is a more secure option than alternative data transfer methods. API Access supports the standard protocol for authorisation, OAuth2, ensuring that only authorised users can access the system and carry out certain API calls.
  • 5. Get started with ease with REST API
    It is easy to get started with API Access if you have software development capabilities in-house or have partnered with someone who has them since API Access is based on best practices such as REST, JSON, and OAuth2 and is thoroughly documented via Swagger UI.

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.

How does API Access work
Discover more
Close

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?

Close

Do you still have questions about API Access?

Look through our FAQ

  • API Access
  • Security
  • Get Started
  • Questions
  • All

API Access

  • What is API Access? The (short) technical explanation
    READy API Access is a RESTful Application Programming Interface (API) that can be used to programmatically create apps and services and perform other tasks that could previously only be accomplished within Kamstrup’s software suite. API Access supports regular REST requests and webhooks and is only available to customers hosted in Kamstrup’s hosting environment (at an additional cost).
  • Do you have examples of how other utilities use API Access?

    Different utilities use API Access for different things. Still, some of the significant use cases that we see are:

    1. Using API Access to build an in-house data warehouse to create the best possible data foundation
    2. Using API Access to integrate READy with the billing system to ensure billing conformity
    3. Using API Access to enable the usage of third-party meter exchange tools to update meter exchanges in READy automatically
    4. Using API access to integrate data into consumer portals or consumer applications, so these are automatically updated with the newest information
  • What are the overall benefits of API Access?

    There are several benefits to using API Access. The significant advantages are:

    1. Make READy interoperable with other systems
    2. Automate manual processes
    3. Rely on the newest data and alarms
    4. Reflect changes from one system back into READy
    5. Securely transfer data between systems
    6. Get your software developers started quickly
  • What is the difference between a REST request and a webhook?

    In standard request-response REST APIs, data is served upon request, making them reactive. That means that they react upon request but typically do nothing on their own without prompting from the user. On the other hand, a webhook is event-driven, which means it allows one system to send data to another as soon as a given event takes place.

Security

  • Is API Access secure?

    Yes. API Access supports delegated OAuth2 access, which means that all external service calls must include a valid OAuth2 authentication token as a Bearer Token. Authentication tokens check that users are who they claim to be and that they have access rights for the specific API call they are trying to use. The token is created based on a tenant ID, a client ID, and a client secret. Additionally, webhooks/subscriptions need to be verified with an API key found in READy Manager. API Access utilises HTTPS, meaning that the Transport Layer Security (TLS) protocol is used to encrypt standard HTTP requests and responses. With API Access, data is also encrypted during transfer with SSL certificates.

  • How is sensitive data managed through API Access?
    All data managed through API Access is handled in the same secure way. For an introduction to how data is secured, see the answer to “Is API Access secure?” above.

Get started

  • How do I get started with API access?
    API Access is an add-on to READy Manager, and to get started, you need to reach out to your Kamstrup sales representative and order access. To begin building your own solutions with API Access, we suggest you read through our how-to guide called “Get started with API Access” and check out our online documentation: EU & US.
  • What are the prerequisites to start using API Access?

    Four easy steps need to be taken for you to start using API Access: (1) You need to be a Kamstrup READy-hosted customer; (2) You need an active email and phone number; (3) You need an active server if you want to use webhooks; and (4) You need to have software development capabilities in-house, or partner with someone who has them as Kamstrup does not deliver consultancy services related to the API.

    Read more in the datasheet called “READy – API Access”.

  • How can API Access help streamline internal workflows?
    API Access enables software developers to automate various tasks across systems and applications. This can help improve, for instance, billing workflows as computers rather than people perform tasks which allows you to achieve more efficient and effective workflows by reducing manual errors and cutting costs.
  • Once I develop my solution, can I test it on non-production data?
    Kamstrup offers a product called “API Access – Development Environment”, which you can buy to test out your solutions before implementation in your live system. The primary benefit is that this product allows you to write and test your code without messing up production data. Reach out to your Kamstrup sales representative to hear more.
  • Is the new API Access sandbox, “API Access – Development Environment”, included in my API Access or READy subscription?
    No. The API Access sandbox is a standalone product. This means that it comes with its own separate price and contractual terms. Reach out to your Kamstrup sales representative to order access.

Often asked questions

API Access

Let’s get the conversation started

How can we help you today?

I need

I want to

I wish to

1 2 3 4 5 6