API-Schlüssel und die API
Erlauben Sie einem anderen System, Ihre IDup-Daten unter einem Schlüssel zu lesen und zu schreiben, den Sie erneuern oder löschen können, und finden Sie den API-Leitfaden.
Ein API-Schlüssel ist ein Passwort, das zu einem Programm statt zu einer Person gehört. Behandeln Sie es genauso: Erstellen Sie einen pro System und ersetzen Sie ihn, wenn sich dieses System ändert.
Erstellen Sie einen Schlüssel
- Öffnen API → API-Verwaltung und drücken Sie Neuer Schlüssel.
- Geben Sie ihm einen Namen, der sagt, welches System es verwendet.
- Wählen Sie seine Berechtigungen: Voller Zugriff, oder nur die Bereiche, die das System benötigt. Die meisten Bereiche unterscheiden zwischen Lesen, Erstellen und Ändern.
- Wählen Sie ein Ablaufdatum oder keines.
- Verwenden Sie Anzeigen und Kopieren auf die Schlüsselkarte, um den Schlüssel an das aufrufende System zu übergeben. Das System sendet ihn im authtoken Kopfzeile.
Jede Schlüsselkarte zeigt die Berechtigungen, das Erstellungsdatum, Zuletzt verwendet und ein Abzeichen wie „aktiv“ oder „läuft in 5 Tagen ab“.
Einen Schlüssel erneuern, bevor er abläuft
Vierzehn Tage bevor ein Schlüssel abläuft, erhalten Sie eine Benachrichtigung in der Glocke. Drücken Sie Erneuern auf die Schlüsselkarte und wählen Sie das neue Ablaufdatum. IDup erstellt einen neuen Schlüssel mit denselben Berechtigungen. Kopieren Sie ihn sofort, da diese Anzeige nur einmal erscheint. Der alte Schlüssel bleibt bis zu seinem eigenen Ablaufdatum gültig, sodass Sie das System ohne Unterbrechung umstellen können.
Die Bereiche, die Sie erreichen können
Die API umfasst Ihre Kundendaten und, je nach Ihrem Abonnement, Liegenschaften und Vermietungen, Suchprofile, Steuerakten, Treuhandakten, Buchhaltung, Lohnläufe und Belegerfassung. AI Studio und das Postfach haben ihre eigenen Bereiche. Der API-Leitfaden listet nur die Bereiche auf, die Ihr Abonnement umfasst.
Der API-Leitfaden
Öffnen Sie die Dokumentation Tabulator auf der API-Verwaltungsseite oder API → API-Leitfaden. Jeder Bereich zeigt seine Felder, Anforderungsbeispiele, die Sie kopieren können, Beispielantworten und Fehlercodes.
Webhooks und andere Schnittstellen
- Der Webhooks Tabulator sendet Ereignisse an Ihr System, sobald sie auftreten — siehe Senden Sie Ereignisse mit Webhooks an Ihr eigenes System.
- Wenn die Kunden-API eingeschaltet ist, ein Kunden-API-Einstellungen Tabulator öffnet seine Einstellungen, zum Beispiel ob sich Kunden über die API registrieren dürfen.
- Automatisierung / Workflows → Technische Schnittstelle stellt ein Token für die GraphQL-Schnittstelle aus.
- AI Studio → Persönliche API-Schlüssel ist ein separater Satz von Schlüsseln.
Sicherheit bewahren
- Ein Schlüssel pro System, niemals ein geteilter.
- Geben Sie einem Schlüssel nur die Berechtigungen, die das System benötigt.
- Legen Sie ein Ablaufdatum fest und erneuern Sie nach einem Zeitplan.
- Löschen Sie einen Schlüssel, sobald jemand, der ihn kannte, das Unternehmen verlässt oder das System ausgeschaltet wird.
Nichts wird verfolgt — die Schaltflächen öffnen nur eine Nachricht, damit Sie uns mitteilen können, was gefehlt hat.
