Szerver és URL-ek

Minden API-végpont relatív az alap URL-hez https://api.auroravision.net/api/rest.
A hívni kívánt API-tól függően összefűződik az alap URL és az elérési út paraméterei, amelyek meghatározott erőforrásokhoz és szolgáltatásokhoz rendelt végpontokat hívnak meg.
Például, ha feltételezzük, hogy hitelesíteni szeretne, az API a https://api.auroravision.net/api/rest alap URL-ből áll, amely a /authenticate elérési út paraméterrel kifejezett végponthoz kapcsolódik.

Mindig fontos szem előtt tartani, hogy minden API mindig különböző paraméterekből áll:

• Path: az URL-útvonal változó részei, amelyek egy adott erőforrásra mutatnak a gyűjteményben, ezek mindig kötelezőek;
• Header: a HTTP-kérés vezérlő paramétere, ezek szükségesek a szerveroldali válaszhoz;
• Query: kötelező és nem kötelező, az API-hívások szűrésére és testreszabására szolgálnak, meghatározott szintaxissal láncolva;

Az API-szolgáltatáson keresztül indított hívások fejléceként az X-AuroraVision-Token szerepel.
A token beszerzéséhez használnia kell az Authentication API az Aurora Vision-fiók hitelesítő adatainak i és az X-AuroraVision-ApiKey megadásával a hívás header.

Lehetőség van az összes API megtekintésére a paraméterek leírásával a megfelelő dokumentáción (OpenAPIs Swagger) keresztül.