Customer API / V1

Customer API documentation

Export approved production data, build a passwordless integration, and understand the public Customer API contract.

In this article

Get the API tools

Use the package that matches the result you need:

Manage your production integration in the Wavac Dashboard under Settings > Customer API, with the intended customer selected. Ask your customer administrator for access if the tab is unavailable.

Package Use it to Get it
Postman test package Exercise the isolated static test API with 24-hour Bearer and mTLS credentials without consuming customer quota. In Settings > Customer API, select Generate Postman test package. The standard limit is 10 generation requests per user per UTC day, shared across customers.
Azure reference package Deploy the platform-managed mTLS discovery job and keep its private key in the customer workload. Sign in as a Customer API administrator and download the Azure reference package. No Admin portal access is needed.

The Postman package contains isolated test credentials, not credentials scoped to the customer or user requesting it. It exercises synthetic data only and is never available from a public static link. The Azure package contains source and deployment assets but no customer credentials. Production access requires a separately approved integration and its own credentials.

Get started with Postman

Use the Postman quickstart to import a 24-hour test package, verify the static test surface, and make your first aggregate request without using customer quota.

To build a scheduled integration, implement discovery as an Azure scheduled job. The supplied C# and Python implementations use managed identity, Key Vault certificate storage, automatic mTLS renewal, and private Blob diagnostics.

CSV export

If you need a file rather than an API client, export Dashboard data to CSV. CSV and direct API access apply the integration's data-access settings and expose only approved Friendly Tags and downtime data.

Build an integration

The integration guide connects the normal workflow: enroll, authenticate, discover scope, query data, page results, and handle effective limits. Read Customer API authentication for recommended platform-managed mTLS and optional customer-managed assertions. Azure-hosted services can implement the managed mTLS discovery job or use Microsoft Entra and Key Vault for a customer-managed signer.

Use the endpoint references when you need an exact request or response contract:

Reference Use it to
Discovery API Read the authorized hierarchy, Friendly Tags, filters, and effective limits.
Aggregate data API Query time-weighted aggregate Friendly Tag values.
Downtime API Query downtime events and active downtime codes.

The integration guide explains the shared wire contract, compatibility expectations, and how clients should tolerate additive changes.

Interpret changing data

Aggregate responses represent the data available when each request is made. Late or corrected observations can revise prior buckets, and a cursor continues a traversal without freezing the result set. Read pagination and data consistency before building durable imports or historical reports.

Protect and troubleshoot access

The Customer API security guide covers least privilege, credential custody, transport, logging, rotation, and incident response. When a request fails, resolve Customer API errors starts from the HTTP status and problem response without exposing credentials or customer data.