REST-sovellusliittymä

REST-rajapinta (API) on joukko verkkosoitteita, jotka palveluntarjoaja julkaisee, jotta ohjelmistosi voi lähettää pyynnön ja vastaanottaa jäsennellyn vastauksen. Järjestelmäsi suorittaa todennuksen, lähettää pyynnön – esimerkiksi paneelitilauksen – ja lukee vastauksen koodimuodossa. Aniva-rajapinta käyttää API-avaimen otsikkoa, idempotenssiotsikkoa turvallisten uudelleenkokeilujen mahdollistamiseksi sekä testitietoja sisältävää testausympäristöä. Ohjeet löytyvät osoitteesta docs.anivahealth.com.

Käyttöliittymällä on merkitystä arvioinnissa, sillä se määrää, kuinka paljon työtä insinöörit tekevät kertaluonteisesti ja kuinka paljon operatiivinen tiimi joutuu toistamaan käsin päivittäin. Testausympäristön avulla kehittäjät voivat kokeilla käyttöliittymää ennen sopimuksen allekirjoittamista, mikä on edullisin tapa selvittää, kuinka hyvä se on.

• Pyydä ohjeiden URL-osoite ja lue ne ennen ensimmäistä teknistä puhelukeskustelua.
• Kysy, onko testitietoja sisältävää testausympäristöä olemassa ja miten tiimisi voi hankkia siihen käyttäjätunnuksen.
• Kysy, miten toistuvat pyynnöt käsitellään, sillä yksi tilaus ei saa missään tapauksessa tuottaa kahta näytettä.
• Kysy, mitä virheviesti sisältää, kun tilaus hylätään.
• Kysy, miten sinulle ilmoitetaan käyttöliittymän muutoksista ja kuinka kauan vanhemmat versiot pysyvät toiminnassa.

Integrointi ei ole ainoa tapa aloittaa, sillä Anivalla on myös kumppanikonsoli, jota tiimisi voi käyttää ilman koodin kirjoittamista. Monet kumppanit käyttävät molempia: API:ta omassa tuotteessaan ja konsolia tukitiiminsä tarpeisiin.

Tässä sanastossa kohdassa ”Webhook” selitetään, miten tilanmuutos välittyy järjestelmääsi, kohdassa ”Partner-Portal” käsitellään menettelytapaa tiimille, jossa ei ole kehittäjiä, ja kohdassa ”FHIR” käsitellään standardia, jota institutionaalinen ostaja saattaa vaatia.