Server und URLs

TAlle API-Endpunkte sind relativ zur Basis-URL https://api.auroravision.net/api/rest.
Basierend auf der API, die Sie aufrufen möchten, haben Sie eine Verkettung zwischen der Basis-URL und den Pfadparametern, die Endpunkte aufrufen, die bestimmten Ressourcen und Diensten zugeordnet sind.
Angenommen, Sie möchten sich beispielsweise authentifizieren, besteht die API aus der basis https://api.auroravision.net/api/rest mit dem Endpunkt verkettet, der mit dem Pfadparameter ausgedrückt wird /authenticate.

Es ist immer wichtig zu bedenken, dass jede API immer aus verschiedenen Parametern bestehen wird:

• Path: teile eines URL-Pfads, die verwendet werden, um auf eine bestimmte Ressource innerhalb einer Sammlung zu verweisen, sind sie immer erforderlich;
• Header: treiberparameter für die HTTP-Anfrage, sie sind erforderlich, um eine serverseitige Antwort zu erhalten;
• Query: können erforderlich und optional sein, sie werden verwendet, um den API-Aufruf zu filtern und anzupassen, indem sie mit einer bestimmten Syntax verkettet werden;

Jeder Aufruf, der über den APIs-Dienst getätigt wird, hat die X-AuroraVision-Token als seine header.
Um das Token zu erhalten, müssen Sie die verwenden Authentication API indem Sie die Anmeldeinformationen für das Aurora Vision-Konto zusammen mit dem eingeben X-AuroraVision-ApiKey als header des aufrufs.

Es ist möglich, alle APIs mit einer Beschreibung der Parameter über die entsprechende Dokumentation anzuzeigen (OpenAPIs Swagger).