API-Zugang & Tokens
Der API-Zugang erlaubt es deinem System, Postkarten und Kampagnen programmatisch an PostPal zu übergeben. In den API-Einstellungen erzeugst du Account-gebundene Tokens, verwendest sie für authentifizierte Requests und kannst sie bei Bedarf wieder löschen. API-Requests werden protokolliert, damit du Fehler und Nutzung nachvollziehen kannst.
Der API-Zugang ist für technische Integrationen gedacht, die Postkarten oder Kampagnen automatisch an PostPal übergeben.
Grundlagen:
- Du erzeugst einen API-Token in den Account-Einstellungen.
- Der Token authentifiziert Requests für deinen Account.
- Du kannst Tokens wieder löschen, wenn sie nicht mehr gebraucht werden.
- PostPal protokolliert API-Requests in den API-Logs.
Nutze die Entwickler-Dokumentation unter
https://app.getpostpal.com/developers/api, wenn du Endpunkte, Pflichtfelder
oder Beispiel-Requests nachschlagen möchtest. Die maschinenlesbare
OpenAPI-Spezifikation liegt unter
https://app.getpostpal.com/developers/api/openapi.json; die Postman Collection
unter https://app.getpostpal.com/developers/api/postman.json.
Häufige Fragen
Wo erstelle ich einen API-Token?
API-Tokens erstellst du in PostPal unter Einstellungen > API. Der Token ist an den aktiven Account gebunden.
Kann ich einen Token widerrufen?
Ja. Lösche den Token in den API-Einstellungen, wenn er nicht mehr verwendet werden soll.
Wo finde ich die API-Dokumentation?
Die offizielle Entwickler-Dokumentation findest du unter https://app.getpostpal.com/developers/api. OpenAPI liegt unter https://app.getpostpal.com/developers/api/openapi.json, Postman unter https://app.getpostpal.com/developers/api/postman.json.