Cloudwater

Edge modulesPublic API Module

Your Edge data, wherever you need it

The Edge Public API gives your other systems secure, configurable, read-only access to the data held in Edge, delivered as rich, structured JSON.

Book a conversationSee all modules

With the Edge Public API, retailers gain

  • Custom endpoints

    Access exactly the data you need, shaped for the system using it.

  • Scoped API keys

    Controlled, secure access, with each key limited to approved data.

  • Nested objects and arrays

    Rich, structured business data, returned as complete objects rather than flat rows.

  • OpenAPI documentation

    Quick and easy to integrate, with standard developer tooling.

How it works

From approved data to the systems that use it

You decide which Edge data is made available. Client systems send an API request, and Edge returns the approved data as read-only JSON.

Approved data

  • Customers, accounts and market data
  • Quotes, tariffs and charges
  • Premises, meters and consumption
Approved Edge data (customer data, quotations and operational data) flows through the Edge Public API as read-only JSON: a customer object holding an address and an array of premises, each with an array of meters, delivered to client systems such as CRM, Reporting and BI tools and client portals

Scroll sideways to see the whole diagram.

Built for integration

Flexible, secure and simple to connect

The Edge Public API fits around the way your business works. Share the data you choose with the systems you choose, without compromising on security.

  • Flexible: endpoints shaped around the data each system needs
  • Secure: read-only access, with every key limited to approved data
  • Complete: related information arrives together, ready to use
  • Simple to connect: clear documentation for your developers and partners
Edge Public API

Example request: GET /customers/C1024, with Authorization Bearer ••••••••••••. Response: 200 OK.

{
  "customerId": "C1024",
  "name": "Northwater Retail Ltd",
  "address": {
    "addressLine1": "1 Water Way",
    "city": "Reading"
  },
  "premises": [
    {
      "premiseId": "P1001",
      "name": "Riverside House",
      "meters": [
        { "meterId": "MTR001" },
        { "meterId": "MTR002" }
      ]
    },
    {
      "premiseId": "P1002",
      "name": "Oak Business Park",
      "meters": [
        { "meterId": "MTR010" },
        { "meterId": "MTR011" }
      ]
    }
  ]
}
Client systems

Put Edge data to work across your business

Feed the systems your teams and customers already use with accurate, up-to-date Edge data.

  • CRM

    Customer insights and account management.

  • Reporting and BI

    Analytics and regulatory reporting.

  • Client portals

    Self-service for customers and partners.

Frequently asked questions

Questions retailers ask about the Public API

Can the Edge Public API change data in Edge?

No. The Public API is read-only. Client systems request data and Edge returns it as JSON; nothing sent to the API alters customer, quotation or operational records in Edge.

How is access to the Edge Public API controlled?

Every request is made with an API key, and each key is scoped to the endpoints and data it is approved for, so one integration only sees what it needs.

What does the API return?

Complete, ready-to-use records rather than scattered pieces. Ask for a customer and the related details, such as their sites and meters, come back together, so your systems have the whole picture straight away.

Is the API documented?

Yes. Endpoints are described in OpenAPI documentation, so developers can explore requests and responses and generate client code with standard tooling.

Works with

Modules that pick up where this one leaves off

Explore How Edge Could Support Your Retail Operation

If you’d like to understand how Cloudwater Edge could support your business, we’d be happy to talk through your current setup, challenges and plans.

Book a conversation
Prefer to call?01282 525514Or drop us a lineenquiries@cloudwater.co.uk