Server e URLs
Todos os endpoints de APIs são relativos à URL base https://api.auroravision.net/api/rest
.
Com base na API que você deseja chamar, você terá concatenação entre a URL base e os parâmetros de caminho que chamam endpoints dedicados a recursos e serviços específicos.
Por exemplo, supondo que você queira autenticar, a API consistirá na URL base https://api.auroravision.net/api/rest
concatenada ao endpoint expresso com o parâmetro de caminho /authenticate
.
É sempre importante ter em mente que qualquer API sempre consistirá em parâmetros diferentes:
Path
: partes variáveis de um caminho de URL usado para apontar para um recurso específico dentro de uma coleção, eles são sempre obrigatórios;Header
: parâmetro de condução para solicitação HTTP, eles são necessários para obter uma resposta do lado do server;Query
: podem ser obrigatórias e opcionais, são utilizadas para filtrar e customizar a chamada da API encadeando-as com sintaxe específica;
Qualquer chamada feita através do serviço de APIs tem como cabeçalho o X-AuroraVision-Token
.
Para obter o token, você precisa usar a API de Autenticação
inserindo as credenciais da conta do Aurora Vision i junto com o X-AuroraVision-ApiKey
como o header
da chamada.
É possível visualizar todas as APIs, com descrição dos parâmetros, através da documentação apropriada (OpenAPIs Swagger).