Serwer i URLs

Wszystkie punkty końcowe interfejsów API są względne w stosunku do podstawowego adresu URL https://api.auroravision.net/api/rest.
W oparciu o interfejs API, który chcesz wywołać, będziesz mieć połączenie między podstawowym adresem URL a parametrami ścieżki, które wywołują punkty końcowe przeznaczone dla określonych zasobów i usług.

Na przykład zakładając, że chcesz uwierzytelnić, interfejs API będzie składał się z podstawowego adresu URL https://api.auroravision.net/api/rest połączonego z punktem końcowym wyrażonym za pomocą parametru ścieżki /authenticate.

Należy zawsze pamiętać, że każdy interfejs API zawsze będzie składał się z różnych parametrów:

• Path: zmienne części ścieżki URL używane do wskazywania określonego zasobu w kolekcji, zawsze są wymagane;
• Header: parametr sterujący dla żądania HTTP, są wymagane do uzyskania odpowiedzi po stronie serwera;
• Query: może być wymagane i opcjonalne, służą one do filtrowania i dostosowywania wywołania API poprzez łączenie ich z określoną składnią;

Każde wywołanie wykonane za pośrednictwem usługi API ma nagłówek X-AuroraVision-Token.
Aby uzyskać token, musisz użyć interfejsu API Uwierzytelniania, wprowadzając poświadczenia konta Aurora Vision i wraz z X-AuroraVision-ApiKey jako header wywołania.

Możliwe jest przeglądanie wszystkich API, wraz z opisem parametrów, poprzez odpowiednią dokumentację (OpenAPIs Swagger).