Kolmannen osapuolen sovellusten integrointi Provet Cloudiin

Integrointiratkaisun esimerkki

Verkkokoukut

REST API

Integrointisovelluksen lisääminen Provet Cloudiin

Uuden asiakkaan rekisteröinnin vaihtoehdot

Luvat

Integraation vapauttaminen

Provet Cloud -eläinlääkärin vastaanotonhallintajärjestelmä voidaan integroida kolmannen osapuolen sovelluksiin REST API ja webhooks -työkalujen avulla.

Webhooks on käytettävissä Provet Cloudissa, jotta voit lähettää ilmoituksia kolmansien osapuolten järjestelmiin Provet Cloudin sisällä oleviin tietoihin tehdyistä lisäyksistä tai muutoksista. Webhookit eivät siirrä varsinaisia muuttuneita tietoja, vaan ne siirtävät tietoa siitä, mikä on muuttunut, yksinkertaisesti ilmoittamalla muutoksesta kolmannen osapuolen järjestelmälle. Kolmannen osapuolen järjestelmä voi sitten hakea varsinaiset tiedot Provet Cloudin REST API:n avulla.

REST API on viestintämenetelmä, jolla kolmannen osapuolen sovellukset voivat käyttää, muokata tai lisätä Provet Cloudissa olevia tietoja ohjelmallisesti. Provet Cloudin REST API tarjoaa suurimman osan Provet Cloudin keskeisistä tiedoista muiden järjestelmien luettavaksi tai käsiteltäväksi.

Provet Cloud -verkkokoukkujen yhdistelmä & REST API luo ainutlaatuisia mahdollisuuksia integroitujen ratkaisujen rakentamiseen. Kaikki muiden järjestelmien toimittajat, jotka tuntevat nämä tekniikat, voivat helposti integroida Provet Cloud -eläinlääkärin vastaanotonhallintajärjestelmässä olevia tietoja hyödyntämällä näitä tekniikoita.

Ennen kuin voit aloittaa Provet Cloudin sovellusliittymien käytön, meidän on annettava sinulle pääsy testiympäristöön. Ota yhteyttä kumppanikehityspäällikköömme, niin pääset alkuun.

Luomme testiympäristön, jota voit käyttää alkukehityksen aikana. Luomme sinulle myös integraatiomallin, jossa on haluttu OAuth2-valtuutustyyppi, jotta voit käyttää testiympäristöäsi. Näin voit kehittää ja testata koodiasi API:n kanssa.

Katso kehittäjäsivuiltamme API-dokumentaatio, API-skeema ja muuta arvokasta tietoa, joka auttaa sinua kehitystyössäsi.

Verkkokoukut määritetään ja otetaan käyttöön osoitteessa Asetukset > Yleistä > Integraatiot > Verkkokoukut. Esimerkki: "consultation_id=123".

Provet Cloud tarjoaa REST API:n, jonka avulla voidaan käyttää Provet Cloudiin tallennettuja tietoja. API käyttää OAuth 2.0 -todennusta. Tiedot palautetaan JSON -muodossa.

Provet Cloud REST API on selattavissa, minkä pitäisi antaa kehittäjille hyvät mahdollisuudet arvioida tiedonsiirtomahdollisuuksia.

Kun malli on luotu, integraatio näkyy Provet Cloudin integraatioluettelossa: Asetukset > Integraatiot > Open API access > Add Application. Luettelossa luetellaan käytettävissä olevat integraatiot ja siinä on lyhyt kuvaus siitä, mitä kukin integraatio tekee. Jos integraatiolla on lisäasennusohjeita, myös ne näkyvät luettelossa.

Integraatioilla voi olla rajoitettu näkyvyys: ne voidaan rajoittaa koskemaan vain tiettyjä Provet Cloud -vuokralaisia tai tiettyjä maita. Integraation tarjoava kolmas osapuoli voi valita, kuinka laajasti integraation on oltava näkyvissä vuokralaisille. Kun rajoituksia on, sovellus näkyy integraatioluettelossa vain niissä vuokralaisissa / niissä maissa, joissa se on sallittu.

Aina kun uusi asiakas rekisteröityy käyttämään integraatiota eli valitsee sen Provet Cloudin integraatioluettelosta (Lisää sovellus), integraation tarjoajalle lähetetään asiakkaan yksilölliset tunnistetiedot. Uuden asiakkaan rekisteröinnistä ilmoittamiseen on kaksi vaihtoehtoa, jotka voidaan valita integraatiomallia luotaessa:

Kun integraatiota käytetään vain yhdessä Provet Cloud -instanssissa, sähköposti on hyvä valinta: silloin sähköpostin vastaanottaja voi määrittää tunnistautumistiedot integraatiolle ja aloittaa sen käytön. Toisaalta, kun integraatiota käytetään laajasti, suositellaan kytkentä-URL:ää ja uuden asiakkaan lisäämisen automatisointia.

Hookup URL kuuntelee automaattisia ilmoituksia uusista asiakkaista. Kun uusi asiakas lisää integraation Provet Cloudiin, orkestrointityökalu lähettää automaattisesti JSON-viestin kyseiseen URL-osoitteeseen. Mitään inhimillistä vuorovaikutusta ei tarvita, kun integraatio jäsentää uuden asiakkaan automaattisesti JSON-viestistä ja lisää hänen tunnistetietonsa asiakastaulukkoonsa.

JSON-skeema uusien integraatiorekisteröintien yhteydessä lähetettäville tiedoille:

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"required": [
     "provet_id",
     "client_id",
     "client_secret",
     "algorithm",
     "authorization_grant_type",
     "client_type",
     "redirect_uris",
     "token_url",
     "authorize_url",
     "openid_autodiscovery_url"
],
"properties": {
     "provet_id": {
          "type": "number",
          "description": "Provet ID of the tenant who added this integration."
     },
     "client_id": {
          "type": "string"
     },
     "client_secret": {
          "type": ["null", "string"]
     },
     "algorithm": {
           "type": ["null", "string"],
           "description": "Signing algorithm used.",
           "examples": [null, "HS256", "RS256"]
     },
     "authorization_grant_type": {
           "type": "string",
           "description": "Authorization flow used.",
           "examples": ["authorization-code", "client-credentials"]
     },
     "client_type": {
           "type": "string",
           "description": "Client type.",
           "examples": ["confidential", "public"]
     },
     "redirect_uris": {
           "type": "string",
           "description": "Space-separated list of callback URIs.",
           "examples": ["https://example.com/callback"]
     },
     "token_url": {
            "type": "string",
            "description": "OAuth2.0 token endpoint URL."
     },
     "authorize_url": {
            "type": "string",
            "description": "OAuth2.0 authorize endpoint URL."
     },
     "openid_autodiscovery_url": {
            "type": ["null", "string"],
             "description": "OpenID autodiscovery URL. Null if integration does not use OpenID."
     }
 }
}

Kun uusi integraatiosovellus lisätään Provet Cloudiin, integraatiolle luodaan automaattisesti virtuaalikäyttäjä ja luparyhmä. Virtuaalikäyttäjän nimi on Integraatio <Integraation nimi> ja se löytyy Asetukset > Käyttäjät suodattimen Virtuaalinen avulla. Käyttöoikeusryhmällä on sama nimi kuin integraatiolla.

Provet Cloud tukee automaattista käyttöoikeuksien hallintaa, mikä vähentää manuaalista työtä ja varmistaa johdonmukaisuuden. Tätä ominaisuutta kutsutaan nimellä "lupamalli", ja se lisätään integraatiomalliin. Ota yhteyttä Provet Cloud -tukeen saadaksesi lupamallin integraatiomalliisi.

Kun käyttöoikeusmalleja muutetaan, Provet Cloudin vastaava käyttöoikeusryhmä päivitetään automaattisesti vastaamaan uusinta mallia. Lisätyt käyttöoikeudet sisällytetään ja poistetut käyttöoikeudet jätetään pois synkronoinnin varmistamiseksi.

Jos käyttöoikeusmallia ei käytetä, sillä on oletusarvoisesti samat oikeudet kuin käyttöoikeusryhmällä Users.

Jos integraatio vaatii erilaisia oikeuksia (jotkin päätepisteet on kielletty tai haluat rajoittaa oikeuksia), oikeuksia on muokattava. Tarkista Provet Cloud API -kaaviosta, mitä oikeuksia kukin päätepiste tarvitsee. Katso myös Käyttäjien oikeuksien tarkastelu ja hallinta.

Mukautetut integraatiot

https://developers.provetcloud.com/

Esimerkki integraation asennusoppaasta

Integrointiratkaisun esimerkki