Server et URLs

Tous les points de terminaison des API sont relatifs à l’URL de base https://api.auroravision.net/api/rest.
En fonction de l’API que vous souhaitez appeler, vous aurez une concaténation entre l’URL de base et les paramètres de chemin des points de terminaison dédiés à des ressources et services spécifiques.
Par exemple : en supposant que vous souhaitiez vous authentifier, l’API sera composée de l’URL de base https://api.auroravision.net/api/rest concaténé au point de terminaison exprimé avec le paramètre path /authenticate.

En général, il est toujours important de garder à l’esprit que toute API:

• Path: parties variables d’un chemin d’URL utilisé pour pointer vers une ressource spécifique dans une collection;
• Header: piloter les paramètres pour les requêtes HTTP qui sont nécessaires pour obtenir une réponse côté serveur;
• Query: paramètres permettant de filtrer et de personnaliser l’appel API en les enchaînant avec une syntaxe spécifique, ils peuvent être obligatoires ou facultatifs;

Tout appel effectué via le service API a le X-AuroraVision-Token comme header.
Pour obtenir le jeton, vous devez utiliser le Authentication API en entrant les informations d’identification du compte Aurora Vision avec le X-AuroraVision-ApiKey comme header de l’appel.

Il est possible de visualiser toutes les API, avec une description de tous les paramètres, à travers la documentation appropriée (OpenAPIs Swagger).