📊 Artikel-Metadaten
Artikel-Typ | Best Practice |
Erfahrungslevel | 🚀 Grundlagen |
Die Aktivierung der Poool API erfolgt abhängig vom gebuchten Softwarepaket durch den Support (support@poool.cc). Bei der Gelegenheit freuen wir uns sehr, wenn Sie uns ihren Anwendungsfall schildern. Vielleicht können wir zur Anbindung einzelner Tools auch Tipps oder Vorlagen bereitstellen.
Einrichtung der API-Schnittstelle
Unter Einstellungen > API & Webhooks finden Sie den Konfigurationsbereich. Hier können neue API Benutzer erstellt und berechtigt werden.
Über den Button Leitfaden für Entwickler kommen Sie zu unserer technischen Anleitung zur Einrichtung und Konfiguration.
API-Token verwalten
Jeder API-Benutzer kann über einen oder mehrere API-Token verfügen. API-Token funktionieren ähnlich wie Benutzerkonten in Poool: Sie besitzen individuelle Berechtigungen und können jederzeit aktiviert oder deaktiviert werden.
Ein neu erstellter API-Token wird aus Sicherheitsgründen nur einmalig vollständig angezeigt. Stellen Sie daher sicher, dass der Token unmittelbar nach der Erstellung an einem sicheren Ort gespeichert wird. Ein späteres Auslesen des vollständigen Tokens ist nicht möglich.
Berechtigungen vergeben
Die Berechtigungen eines API-Tokens sollten nach dem Prinzip der minimalen Rechtevergabe vergeben werden. Weisen Sie nur die Berechtigungen zu, die für den jeweiligen Anwendungsfall tatsächlich erforderlich sind.
Welche Berechtigungen zur Verfügung stehen, richtet sich nach den aktuell verfügbaren API-Endpunkten. Durch eine gezielte Einschränkung der Berechtigungen kann die Sicherheit der Integration erhöht werden.
Einrichtung Webhooks
Webhooks ermöglichen es, auf bestimmte Ereignisse in Poool zu reagieren und automatisch Aktionen in anderen Systemen auszulösen. So kann beispielsweise ein neu angelegter Kontakt direkt an ein Newsletter-Tool übertragen werden.
Webhooks werden im Reiter „Webhooks“ angelegt und können jederzeit aktiviert oder deaktiviert werden.
Für einen Webhook wird definiert:
- Einen Titel als allgemeine Beschreibung
- Status Aktiv / Inaktiv
- Eine Checksum zur Prüfung der Validität eines Aufrufs.
- Die URL, welche aufgerufen werden soll (meist aus dem Workflow Tool Ihrer Wahl als Trigger vorgegeben)
- Das Ereignis, bei welchem die URL aufgerufen werden soll
Technische Dokumentation
Link zur technischen Dokumentation: Poool API & Webhooks