API keys for your developers
Your own systems, such as a webshop or a CRM, can send cards through the PostBuddy API. They prove who they are with an API key. Owners, Admins and Developers can create keys in Developers.
Live and test keys
| Mode | What it does |
|---|---|
| Live | Creates real mail that is printed, sent and charged. Live keys need the API access feature in your plan. |
| Test | Creates test items that go through every step but never reach production. Always free. |
Start with a test key. Switch to a live key once your developer has checked that everything works.
Create a key
- Open Developers and choose Create key on the API keys tab.
- Enter a Name that says where the key is used, for example "Webshop".
- Choose the Mode: Test or Live.
- Tick the Scopes: what the key may do. You can only give scopes that your own role has.
- Choose Create key and copy the secret straight away. It is not shown again.
Treat a key like a password. Share it only through a safe channel, and never put it in an email or a public code repository.
Keep track of your keys
The list shows each key with the date it was last used. Open the menu of a key and choose Details to see its prefix, its scopes and when it was created. Filter on Live or Test with Mode.
If a key is no longer needed, or may have leaked, open its menu and choose Revoke. Requests with that key are refused from then on. This cannot be undone; create a new key instead.
What else your developer finds here
| Tab | What it shows |
|---|---|
| Webhooks | Endpoints that receive status updates. See Webhooks in short. |
| Logs | The API requests of the last 30 days, without their contents. |
| Events | Every status event of the last 30 days. |
| Test runs | Moves ready test items through a simulated production run. |
| Exports | Downloads of your data. See Export your data. |
A Postflow shows the Postflow id your developer needs on its first step. The technical details are in the developer guides, starting with authentication and test mode.
Open a support ticket in the portal. Tell us what you tried and, if you can, which item or Postbatch it is about.