Postman collection
Every endpoint, ready to send.
The collection is generated from the same contract these reference pages are built from, so it carries all nine endpoints with their real request bodies and no hand-maintained copy to go stale.
What is in it
- One folder per area: Account, Verification, Orders, Catalogue.
- A request per endpoint, with an example body filled in.
{{base_url}}, preset to staging.{{api_key}}, used as a bearer token on every request.- Order bodies using the reserved sandbox numbers, so the first send does something rather than failing validation.
Two downloads
With a new test key is the quickest start. It issues a fresh test key on your account and writes it into the file, so the first request works with no setup.
A key's secret cannot be read back after it is created, so this is the only way a prefilled collection is possible: the key has to be a new one. Before anything happens you will be told, and then:
- A new test key appears in your API keys list, named
Postmanwith the date. - Your existing keys keep working. Nothing is revoked.
- The key is in the downloaded file and nowhere else. Not on this page, not in your clipboard, and not recoverable from us.
- It is a test key. It cannot vend against a real meter.
Warning
Treat the downloaded file as a secret. Anyone who has it can spend your sandbox. Do not commit it, and do not share it in a ticket. If it goes somewhere it should not, revoke that key in your dashboard and download again.
Without credentials gives you the same collection with {{api_key}} left
empty. Nothing is created and no secret lands on your disk. Paste a key into
the collection variable yourself.
Using it
- Import the file into Postman.
- Check
base_url. It is set to staging; change it for production. - Send Get account first. It should return
mode: "test". - Then Verify a meter, copy the
access_codeout of the response, and Place an order.
Note
Nothing in the collection updates a variable from a response, on purpose. A
script that silently moves an access_code between requests hides the step
that matters most, which is that an electricity order will not go through
without a verify first. Copy it across yourself the first few times.
Going live with it
Change base_url to production and paste a live key into {{api_key}}.
Important
At that point every order request in the collection spends real money against a real meter, and the bodies are pointed at the sandbox meter numbers, which are not meters anyone owns. Change the bodies before you send one. Better still, keep a separate copy for live and delete the order requests from it.