Eine API (Application Programming Interface) ist "eine Schnittstelle oder ein Kommunikationsprotokoll zwischen einem Client und einem Server".
Mit einfachen Worten, es ist eine Möglichkeit, Daten aus einem Programm zu extrahieren und an ein anderes zu übertragen.
Die Rentman (Public) API ermöglicht es dir, deine eigenen Integrationen mit anderen Programmen zu erstellen. In diesem Artikel geben wir einen allgemeinen Überblick über die Rentman API und Anweisungen für den Zugriff darauf.
Hole dir deinen API-Token
Um die Rentman-API nutzen zu können, musst du einen API-Token generieren. Der API-Token ist personalisiert und wird zur Authentifizierung verwendet - genau wie ein Passwort. Bitte teile diesen Token nicht mit anderen (siehe unsere empfohlenen Vorgehensweisen für API-Sicherheit).
Bitte beachte, dass der API-Token nur 10 Jahre lang verfügbar ist. Diese Änderung gilt nur für neu erstellte Token. Nach 10 Jahren musst du diesen neu generieren.
Um deinen Token zu generieren:
- Gehe zu settings Konfiguration > Account > Integrationen.
- Falls deaktiviert, klicke auf das Feld 'Verbinden'.
- Klicke auf Token anzeigen.
Du kannst diesen Token nun verwenden, um deine API-Integrationen zu erstellen. Wenn du einen neuen Token erstellen möchtest, klicke auf Neu generieren. Der alte Token wird dann ungültig.
Rentman Öffentliche API Dokumentation
Lies unsere Rentman API Dokumentation für alle Informationen über Authentifizierung, Header, Abfragen und Einschränkungen unserer öffentlichen API. Hier findest du auch alle notwendigen Codes für die verschiedenen Aufrufe.
Gute Praktiken für die API-Sicherheit
API-Token ermöglichen den Zugriff auf dein Rentman-Konto und du solltest es auf die gleiche Weise schützen, wie du dein Passwort schützt. Hier sind einige gängige bewährte Tipps für deine API-Sicherheit:
- Stelle den Token nicht der Öffentlichkeit zur Verfügung (wie in Screenshots oder Videos). Hinweis: Das Undeutlich Machen deiner Daten ist nicht immer ausreichend. Am besten verwendest du in deinem Grafikprogramm "Cut"-Funktionen, um die Daten vollständig zu entfernen.
- Wenn du einen Token freigeben musst, generiere einen neuen, um den alten Token zu invalidieren.
- Sende niemals den API-Token per E-Mail, da er den Zugriff auf die Daten deines Kontos ermöglichen würde, wenn Hacker es schaffen würden, in dein E-Mail-Account einzudringen.
- Der Zugriff auf jeden Aufruf wird durch die Rolle des Benutzers bestimmt, der den API-Token generiert hat.
API-Beratung
Wenn du an einer benutzerdefinierten Integration mit einem internen (oder extern beauftragten) Entwickler arbeitest, kann unser technischer Support-Spezialist dir bei Fragen zu unserer API-Dokumentation helfen. Wir helfen dir zwar nicht bei der eigentlichen Programmierung/Erstellung von Integrationen, können jedoch bei anderen Themen über diesen Link beraten.