Über die iDWELL-Schnittstelle (API) können externe Programme mit Ihrem iDWELL-Portal Daten austauschen – z. B. eine eigene Auswertung, ein Dienstleister-Tool oder eine Software eines Partners. Damit ein Programm auf die API zugreifen darf, braucht es Zugangsdaten: eine Client ID und ein Client Secret. Diese Zugangsdaten richtet das iDWELL-Team für Sie ein.
Hinweis: Für die Anbindung Ihres Hausverwaltungsprogramms (ERP) brauchen Sie in der Regel keinen eigenen API-Zugang – die Schnittstellen zu den ERP-Systemen sind in der Rubrik 7. Datenaustausch zu ERP-Systemen beschrieben.
Schritt 1: Zugang anfragen
Schreiben Sie an support@idwell.com und teilen Sie uns kurz mit:
- welches Programm bzw. welcher Partner die Schnittstelle nutzen soll,
- welche Daten ausgetauscht werden sollen,
- über welchen iDWELL-Nutzer der Zugang laufen soll.
Schritt 2: Zugangsdaten erhalten
Wir richten den API-Zugang ein und senden Ihnen die Zugangsdaten zu:
- „Client ID“ – die Kennung des Zugangs.
- „Client Secret“ – das geheime Passwort des Zugangs.
Schritt 3: Zugangsdaten hinterlegen
Tragen Sie Client ID und Client Secret in dem Programm ein, das die Schnittstelle nutzen soll, bzw. geben Sie sie nur an den Partner weiter, der die Anbindung umsetzt.
Achtung: Behandeln Sie das Client Secret wie ein Passwort. Versenden Sie es nicht unverschlüsselt an große Verteiler. Falls es in falsche Hände geraten sein könnte, melden Sie sich bitte umgehend unter support@idwell.com – wir erzeugen dann ein neues Secret.
Zugang ändern oder löschen
Wenn Sie ein neues Client Secret benötigen oder einen API-Zugang nicht mehr brauchen, schreiben Sie uns an support@idwell.com.
- Mit einem neuen Secret wird das bisherige ungültig. Programme, die es verwenden, funktionieren erst wieder, wenn dort das neue Secret eingetragen ist.
- Nach dem Löschen kann über diesen Zugang nicht mehr auf die Schnittstelle zugegriffen werden.
Wo finde ich die API-Dokumentation?
Die technische Dokumentation der iDWELL-Schnittstelle (Endpunkte, Datenformate, Authentifizierung) ist nicht in dieser Wissensdatenbank veröffentlicht. Bitte fordern Sie sie unter support@idwell.com an und beschreiben Sie kurz, welche Daten Sie mit welchem Programm austauschen möchten. So können wir Sie gezielt unterstützen.
Weitere Informationen
- Mehr zu den Schnittstellen zu ERP-Systemen finden Sie hier: 7. Datenaustausch zu ERP-Systemen
- Fehler beim Datenabgleich prüfen: Integrationsprotokoll – Fehlermeldungsanalyse
Für iDWELL Hilfe kontaktieren Sie uns bitte unter support@idwell.com, schauen Sie auf unserem YouTube Kanal vorbei oder besuchen Sie unsere Masterclasses😊💡👍
