Overview
What the API is for and how it's organised.
The Zympler API is a REST API over HTTPS. Requests and responses are JSON, and every request is authenticated with an access token (see Authentication).
| Base URL | https://api.zympler.com/v1beta |
| Version | 0.0.1 |
| Format | JSON, UTF-8 |
The API is in beta (
v1beta). We keep it as stable as we can and announce breaking changes ahead of time, but they can still happen beforev1.
Sections
The API is organised in sections. Each has its own page in the reference, starting with what it's for:
| Section | Endpoints |
|---|---|
| Authentication | 1 |
| Resources | 6 |
| External control | 10 |
| Partners | 30 |
| Plan | 5 |
| Telemetry | 5 |
| Weather | 1 |
| Energy export | 1 |
| ReleaseNote | 2 |
Not available yet
There are no webhooks or event feeds yet: to follow changes, poll the endpoints you need. Both are on our roadmap.