API-Schlüssel und geheime API-Schlüssel erstellen
API-Schlüssel und geheime API-Schlüssel sind die Berechtigungsnachweise, die für die Verwendung eines
API-Hooks erforderlich sind. Damit eine Anforderung an einen API-Hook autorisiert werden kann,
muss sowohl der Header X-API-Key als auch der Header X-API-Secret angegeben werden. Die Werte des
API-Schlüssels und des geheimen Schlüssels stellen die Werte dieser beiden Header dar.
Im Gegensatz zu API-Hooks, die einer einzelnen Testsuite zugeordnet sind, sind API-Schlüssel und geheime Schlüssel einer Testorganisation zugeordnet. Daher ist jedes Paar aus API-Schlüssel und geheimem Schlüssel, das innerhalb einer Testorganisation generiert wird, berechtigt, Anforderungen an alle API-Hooks innerhalb derselben Organisation zu autorisieren, unabhängig von der Testsuite, der der API-Hook zugeordnet ist.
So erstellen Sie einen API-Schlüssel und ein Geheimnis
- Melden Sie sich beim API-Manager an.
- Klicken Sie auf die Kachel Test-APIs.
- Wählen Sie eine Testsuite aus.
- Gehen Sie auf die Registerkarte Einstellungen > API-Hooks und Schlüssel.
- Um Ihren neuen API-Haken zu verwenden, müssen Sie sicherstellen, dass Sie einen API-Schlüssel und ein Geheimnis haben.
- Gehen Sie zum Abschnitt Schlüssel und klicken Sie auf Hinzufügen.
- Geben Sie den Schlüsselnamen ein.
- Klicken Sie auf Speichern. Das System zeigt den Schlüssel und das Geheimnis an. Kopieren Sie es für die spätere Verwendung. wenn Ihr Schlüssel und Ihr Geheimnis eingerichtet sind, finden Sie unter Verwendung von API-Hooks weitere Informationen über die Verwendung des API-Hooks.
Ihr neuer API-Schlüssel ist nun aktiv und wird in der Liste der API-Schlüssel im Navigationsmenü angezeigt. Wenn Sie auf den Schlüssel klicken, wird der Wert des API-Schlüssels angezeigt, falls Sie ihn in der Zukunft erneut referenzieren müssen. Um den API-Schlüssel zu löschen, klicken Sie einfach auf das Symbol Löschen neben dem API-Schlüssel, den Sie entfernen möchten. Dadurch werden alle zukünftigen Anfragen an API-Hooks, die diese Kombination aus Schlüssel und Geheimnis verwenden, ungültig.
Nächste Schritte
- Nächstes Thema: API-Hooks verwenden