Specifikace rozhraní

Viz specifikace rozhraní. Pomocí příkazu Export můžete nechat vygenerovat klientskou část aplikace v různých programovacích jazycích. Pro vývoj je k dispozici také mock REST API. Pro snadné ruční testování rozhraní REST API importujte specifikaci rozhraní ve formátu OAS do Postman.

Specifikace se vztahuje také na modul ALVAO Service Desk Enterprise API.

Verzování

Verze rozhraní REST API jsou označeny čísly hlavní a vedlejší verze, např. 1.1, 1.2 atd.

Tato verze Alvao obsahuje následující verze rozhraní REST API:

Verze ALVAO	Verze rozhraní REST API
25.1	1.3

Adresa URL konkrétní verze rozhraní REST API obsahuje číslo její hlavní verze**, např. https://contoso.onalvao.com/AlvaoRestApi/v1/ pro hlavní verzi jedna. Ačkoli byla zatím vydána pouze první hlavní verze, budoucí verze rozhraní Alvao mohou obsahovat více hlavních verzí rozhraní REST API, které budou rozlišeny číslem hlavní verze v adrese URL.

Každá minoritní verze pouze přidává nové funkce do předchozí minoritní verze a zachovává zpětnou kompatibilitu se všemi předchozími minoritními verzemi téže majoritní verze. Např. aplikace navržená pro rozhraní REST API verze 1.2 bude fungovat ve verzi 1.3 a všech následujících nižších verzích. Chcete-li získat aktuální číslo nižší verze, zavolejte kořenový koncový bod rozhraní REST API pomocí metody GET.

Kompatibilita mezi hlavními verzemi není zaručena.