Du möchtest Kontakte und Firmen aus deinem sync.blue® ADRESSBUCH automatisiert lesen oder schreiben, zum Beispiel aus einem CRM- oder ERP-System oder einem eigenen Skript.
Dafür stellt das sync.blue® ADRESSBUCH eine tokenbasierte HTTP-Schnittstelle bereit: die Public API.
Jede Anfrage gilt genau einem Adressbuch. Du authentifizierst dich mit der UID des Adressbuchs und dem Token aus den Einstellungen.
OpenAPI Dokumentation
Hier findest du unsere OpenAPI Dokumentation: openapi-v1.yaml
Wie aktivierst du die Public API?
Schritt 1: Melde dich an
Melde dich unter https://app.sync.blue/ mit deinen Zugangsdaten am sync.blue® Dashboard an.
Schritt 2: Öffne die Einstellungen deines Adressbuchs
Öffne im sync.blue® Dashboard dein sync.blue® ADRESSBUCH und wechsle in den Bereich Einstellungen.
Schritt 3: Schalte den Token-Zugriff ein
Klappe den Abschnitt Token-Zugriff auf, aktiviere die Option Token-Zugriff und klicke auf Speichern.
Schritt 4: Kopiere UID und Token
Im Abschnitt Token-Zugriff werden nun angezeigt:
- UID – die Kennung deines Adressbuchs. Sie ist Teil jeder API-URL.
-
Token – dein Zugangsschlüssel. Er wird im Header
Authorizationmitgesendet.
Schritt 5: Schränke den Zugriff auf IP-Adressen ein (optional)
Ist für dein Adressbuch der Enterprise-Modus freigeschaltet, trägst du unter Erlaubte IP-CIDRs die Netze ein, aus denen Anfragen kommen dürfen (z. B. 203.0.113.0/24). Anfragen von anderen IP-Adressen lehnt die API mit 403 ab.
Über Zugriffsprotokolle anzeigen siehst du jeden Zugriff, der mit dem Token erfolgt ist.
Schritt 6: Sende eine erste Anfrage
Rufe zum Test alle Kontakte deines Adressbuchs ab. Ersetze <UID> und <Token> durch deine Werte:
curl -H "Authorization: <Token>" \
"https://addressbook.sync.blue/storage/v1.0/addressbooks/<UID>/?source=all"Schritt 7: Prüfe das Ergebnis
Die API antwortet mit 200 und liefert die Kontakte im Feld value als JSON. Die Public API ist nun eingerichtet und kann von deinen Anwendungen genutzt werden.
💡 Pro Tipp
Bei großen Adressbüchern rufst du die Kontakte seitenweise ab: &page=1&page_size=50.
Die Antwort enthält dann ein Objekt pagination mit total_pages. Mehr als 50 Einträge pro Seite sind nicht möglich.
Kommentare
0 Kommentare
Zu diesem Beitrag können keine Kommentare hinterlassen werden.