Upisnik REST API je programsko sučelje namijenjeno programskoj interakciji s Upisnikom studijskih programa u sklopu Informacijskim sustavom Hrvatskoga kvalifikacijskog okvira (ISRHKO). Za pristup sučelju nije potrebna nikakva dodatna autentikacija, nego je resurse moguće slobodno koristiti.


Upisnik REST API implementira web servis temeljen na Hypermediji, konkretnije na HATEOAS ograničenju REST arhitekture gdje servis dinamički daje informacije klijentima o REST sučelju kroz hipermediju koristeći linkove koje dodaje u odgovore. Implementacija je u skladu s Richardsonovim Maturity Modelom:

Ovakav REST API u Richardsonovom Maturity Modelu naziva se Level 3 - Hypermedia Controls.


Implementacija koristi Hypertext Application Language (HAL). HAL specifikacija na standardan i jednostavan način omogućava povezivanje između resursa. Koristeći HAL i standardne HTTP metode (GET, POST, PUT i DELETE) API je lakše čitljiv i programeru i aplikaciji koja ga koristi te time i lakši za korištenje, istraživanje API-ja te za razvoj klijentskih aplikacija.

Programska dokumentacija za ovaj API se može naći na https://hko.srce.hr/upisnici/api, a putem istog URL-a je moguće i dohvatiti podatke. Za dohvat podataka je obavezno za traženu reprezentaciju resursa (Accept) navesti application/hal+json. Svi ostali URL-ovi se mogu mijenjati kroz vrijeme.

  • No labels