API-sleutels voor je ontwikkelaars
Je eigen systemen, zoals een webshop of een CRM, kunnen kaarten versturen via de PostBuddy-API. Ze laten zien wie ze zijn met een API-sleutel. Owners, Admins en Developers kunnen sleutels aanmaken in Developers.
Live en testsleutels
| Modus | Wat het doet |
|---|---|
| Live | Maakt echte post die wordt gedrukt, verzonden en in rekening gebracht. Voor live sleutels moet je abonnement de functie API-toegang bevatten. |
| Test | Maakt testpoststukken die elke stap doorlopen, maar nooit in productie gaan. Altijd gratis. |
Begin met een testsleutel. Stap over op een live sleutel zodra je ontwikkelaar heeft gecontroleerd dat alles werkt.
Een sleutel aanmaken
- Open Developers en kies Sleutel aanmaken op het tabblad API-sleutels.
- Vul een Naam in die zegt waar de sleutel wordt gebruikt, bijvoorbeeld "Webshop".
- Kies de Modus: Test of Live.
- Vink de Scopes aan: wat de sleutel mag doen. Je kunt alleen scopes geven die je eigen rol ook heeft.
- Kies Sleutel aanmaken en kopieer het geheim meteen. Het wordt niet opnieuw getoond.
Behandel een sleutel als een wachtwoord. Deel hem alleen via een veilig kanaal, en zet hem nooit in een e-mail of in een openbare coderepository.
Je sleutels bijhouden
De lijst toont elke sleutel met de datum waarop die het laatst is gebruikt. Open het menu van een sleutel en kies Details om het prefix, de scopes en de aanmaakdatum te zien. Filter met Modus op Live of Test.
Is een sleutel niet meer nodig, of is hij misschien uitgelekt? Open het menu en kies Intrekken. Verzoeken met die sleutel worden vanaf dat moment geweigerd. Dit kan niet ongedaan worden gemaakt; maak in plaats daarvan een nieuwe sleutel aan.
Wat je ontwikkelaar hier nog meer vindt
| Tabblad | Wat het toont |
|---|---|
| Webhooks | Endpoints die statusupdates ontvangen. Zie Webhooks in het kort. |
| Logs | De API-verzoeken van de laatste 30 dagen, zonder de inhoud. |
| Events | Elk statusevent van de laatste 30 dagen. |
| Testruns | Brengt gerede testpoststukken door een gesimuleerde productierun. |
| Exports | Downloads van je gegevens. Zie Je gegevens exporteren. |
Een Postflow toont in de eerste stap de Postflow-id die je ontwikkelaar nodig heeft. De technische details staan in de handleidingen voor ontwikkelaars, te beginnen met authenticatie en testmodus.
Vertel ons wat je hebt geprobeerd en, als dat kan, om welk poststuk of welke Postbatch het gaat.