REST API ist eine Schnittstelle zur Verwaltung Ihrer Dienste mittels eigener Anwendungen.
Jede über die API gesendete Anfrage muss über den HTTP Header mit dem Wert Bearer TOKEN autorisiert werden.
Die Token-Verwaltung finden Sie im Kundencenter unter den Einstellungen Ihres Benutzeraccounts.
- Wie aktiviert man die REST-API Schnittstelle
- Token-Verwaltung
- Testumgebung - Sandbox
- Produktionsumgebung und Dokumentation
Wie aktiviert man die REST-API Schnittstelle
Die Aktivierung der API ist an keine speziellen Accountrechte gebunden. Es reicht, wenn Sie unter Ihrem bestehenden Account ein sogenanntes Token erstellen und aktivieren.
Melden Sie sich im Kundencenter an, gehen Sie zur Bearbeitung der Accountdaten, scrollen Sie nach unten zur API-Verwaltung und fügen Sie ein neues Token hinzu.
Sie können mehrere Token unter Ihrem Account verwalten, die zur Autorisierung der REST-Anfragen verwendet werden. Die Token können Sie jederzeit deaktivieren, siehe Token-Verwaltung.
Detaillierte Schrittfolge:
- Melden Sie sich mit Ihren Zugangsdaten im Kundencenter an. Neue Zugangsdaten können Sie HIER anfordern.
- Klicken Sie auf den Benutzernamen in der rechten, oberen Menüleiste. Eventuell können Sie auch direkt auf den Link zur API-Verwaltung klicken und zum 5. Punkt übergehen.
- Ganz unten auf der Seite, beim Abschnitt API, klicken Sie auf das Pfeil-Icon und anschließend auf Weiter zur API-Verwaltung.
- Kliken Sie auf die Schaltfläche Create a new Token.
- Die Angabe eines Kommentars ist freiwillig und hilft den Überblick über die erstellten Token zu behalten.
- Das Ablaufdatum ist ebenfalls eine freiwillige Angabe.
- Bei der Zugriffsbeschränkung können Sie die IP-Adresse eines Gerätes festlegen, das mit dem Token arbeiten wird. Wenn ein Gerät mit einer anderen IP-Adresse das gültige Token verwenden würde, könnten seine Anfragen nicht verarbeitet werden - die Anfragen würden nicht autorisiert werden.
- Sobald Sie alles Notwendige eintragen, klicken Sie auf Create a new token, anschließend bestätigen Sie das neue Token mit dem Passwort Ihres Accounts und Sie sind fertig.
Token-Verwaltung
Alle erstellten Token verwalten Sie im Kundencenter.
Sie finden Sie im Abschnitt Bearbeitung der Accountdaten, bei der API-Verwaltung. Zur Bestätigung eines neuen Tokens, müssen Sie aus Sicherheitsgründen im letzten Schritt, Ihr Account-Passwort angeben.
Mit dem Klick auf Detail beim erstellten Token können Sie den Kommentar, die Zugriffs-IP oder das Ablaufdatum bearbeiten.
Die IP-Beschränkung funktioniert nur für eine IP-Adresse oder eine Netzmaske in der CIDR-Notation. Wenn Sie den Zugriff auf mehrere IP-Adressen einschränken müssen, müssen Sie für jede dieser IP-Adressen ein neues Token erstellen.
Die erstellten Token können jederzeit deaktiviert werden. Die Deaktivierung des Tokens kann bis zu 10 Minuten dauern.
Deaktivierte Token können nicht vollständig gelöscht werden, sie bleiben im Account erfasst, damit Sie jederzeit nachprüfen können, welche Token Sie in der Vergangenheit verwendet haben.
Testumgebung - Sandbox
Jede über die API gesendete Anfrage muss mittels HTTP-Header mit dem Wert Bearer TOKEN autorisiert sein.
Bevor Sie Ihr eigenes Token erstellen, können Sie die Sandbox auf dem Server nur über den gesicherten Port https://sandboxapi.active24.com verwenden. Ein gültiges Token für diese Sandbox ist 123456qwerty-ok.
Die Anfragen an diese Sandbox bewirken keine System-oder Dienständerungen, sie dient lediglich zu Testzwecken geschriebener Anfragen.
Die Dokumentation für die Testumgebung ist verfügbar unter der Adresse https://sandboxapi.active24.com.
Produktionsumgebung und Dokumentation
Die REST-API-Produktionsumgebung läuft auf dem Server nur über den sicheren Port https://api.active24.com.
Die Spezifikationen aller verfügbarer API-Methoden, finden Sie in der Dokumentation unter der Adresse https://api.active24.com.