Der Schlüssel zum sicheren Zugang zu allen APIs
Oauth ist der Authentifizierungsdienst für die API-Nutzung und bietet eine sichere Verwaltung von Anfragen und Integrationen
Einige kleine Überprüfungen
- Prüfen Sie, ob Sie die API oder den Bereich, für den Sie das Token anfordern, bereits aktiviert haben.
- Prüfen Sie, ob Sie Ihr Sandbox-Konto bereits aktiviert haben, bevor Sie das Token im Test erstellen
- Prüfen Sie, ob Sie alle Anweisungen unter Dokumentation > Schnellstart auf der Ebene der einzelnen API befolgt haben.
Wenn Sie das Token nicht über eine API-Anforderung erstellen können, versuchen Sie es mit dem speziellen Tool unter Authentication.
Haben Sie immer noch Probleme? Füllen Sie das Formular im Support-Bereich aus.
Sie können Ihr verbleibendes Guthaben überprüfen
- mit einer Anfrage an den endpoint GET /credit
- über die Konsole: oben wird der Betrag immer aktualisiert
Ja, Sie können das Token im Bereich Authentication löschen, indem Sie auf das Papierkorbsymbol klicken.
Sie können den Verbrauch aller APIs auf jährlicher, monatlicher und täglicher Basis über spezielle endpoints (counters) überwachen.
In der Konsole gibt es auch einen speziellen Bereich "Usage" auf der Ebene der einzelnen APIs, der es Ihnen ermöglicht, Ihre individuellen (einschließlich kostenlosen) und abonnierten Anfragen sowohl grafisch als auch in Tabellenform zu sehen.
Sobald Sie Ihr Sandbox-Konto aktiviert haben, können Sie unter Preferences den gewünschten Aufladebetrag für Ihre Testumgebung auswählen.
Es entstehen keine wirklichen Kosten, Sie erstellen einfach ein virtuelles Konto zum Testen in einer Umgebung, die mit der Produktionsumgebung identisch ist.
ACHTUNG: Es ist wichtig, das Guthaben aufzuladen, da die Anfragen sonst fehlerhaft sind.
Um Ihr Sandbox-Konto zu aktivieren, klicken Sie direkt im Dashboard auf die Schaltfläche "ACTIVATE SANDBOX" und füllen Sie das Formular aus.
Bitte beachten Sie, dass Sie Ihr Sandbox-Guthaben virtuell aufladen müssen, um testen zu können. Außerdem ist es wichtig, dass Sie die für Testanfragen vorgesehenen Server verwenden.
Das Token, egal ob Test- oder Produktions-Token, hat standardmäßig eine Gültigkeitsdauer von einem Jahr, aber wir empfehlen aus Sicherheitsgründen, kürzere Laufzeiten festzulegen.
Die Liste der Token, Sandbox und Produktion, ist im Abschnitt Authentication verfügbar.
Sie können Token-Informationen über die entsprechenden Endpoints abrufen:
- GET/token zum Abrufen der Liste aller nicht abgelaufenen Token
- GET /token/{token}, um Details zu einem bestimmten Token wie Ablauf und zugehörige Bereiche abzurufen
Das Sandbox-Token wird für Anfragen in der Testumgebung benötigt und kann erst nach der Aktivierung des Sandbox-Kontos erstellt werden.
Das Produktions-Token wird, wie der Name schon sagt, benötigt, um Ihre Anfragen zu stellen, wenn Sie in der Produktionsumgebung veröffentlichen. Das Produktions-Token kann nur für bereits aktivierte APIs oder Scopes erstellt werden.
Um Ihr Token zu erstellen, können Sie Folgendes verwenden
- das spezielle Tool "New Token" im Abschnitt Authentication
- den Endpoint "Post /Token" der Oauth-API. In diesem Fall müssen Sie den APIKey verwenden, der ebenfalls im Abschnitt Authentication verfügbar ist.
Sie können Token sowohl für die Test- (Sandbox) als auch für die Produktionsumgebung erstellen.
Bitte beachten Sie, dass das Produktions-Token nur für bereits aktivierte APIs oder Bereiche erstellt werden kann und das Test-Token erst nach Aktivierung des Sandbox-Kontos erstellt werden kann.
Der APIKey wird für die Erstellung des ersten Tokens benötigt.
Sie können Ihren APIKey, sowohl den Test- als auch den Produktions-APIKey, im Bereich Authentication abrufen. Im gleichen Bereich können Sie auch Ihren APIKey aktualisieren.