Server y URLs
Todos los puntos finales de las API son relativos a la URL base https://api.auroravision.net/api/rest
.
Según la API a la que desee llamar, tendrá una concatenación entre la URL base y los parámetros de la ruta que llaman a los puntos finales dedicados a recursos y servicios específicos.
Por ejemplo, suponiendo que desea autenticarse, la API constará de la URL base https://api.auroravision.net/api/rest
concatenada al punto final expresado con el parámetro de ruta /authenticate
.
Siempre es importante tener en cuenta que cualquier API siempre constará de diferentes parámetros:
Path
: partes variables de una ruta de URL que se utilizan para apuntar a un recurso específico dentro de una colección, siempre son necesarias;Header
: parámetro de conducción para la solicitud HTTP, se requieren para obtener una respuesta del lado del servidor;Query
: pueden ser obligatorias y opcionales, se utilizan para filtrar y personalizar la llamada a la API encadenándolas con una sintaxis específica;
Cualquier llamada realizada a través del servicio de APIs tiene como cabecera el X-AuroraVision-Token
.
Para obtener el token, debe usar la API de Autenticación
ingresando las credenciales de la cuenta de Aurora Vision i junto con X-
AuroraVision-ApiKey como header
de la llamada.
Es posible visualizar todas las APIs, con una descripción de los parámetros, a través de la documentación correspondiente (OpenAPIs Swagger).