Pikalinkit
Johdanto
Provet-eläinlääkärin vastaanoton hallintajärjestelmä voidaan integroida kolmannen osapuolen sovelluksiin REST API - ja webhook-työkalujen avulla.
Webhooks on käytettävissä Provetissa, jotta voit lähettää ilmoituksia kolmansien osapuolten järjestelmiin lisäyksistä tai muutoksista Provetin sisällä oleviin tietoihin. Webhookit eivät siirrä varsinaista muuttunutta tietoa, vaan ne siirtävät tietoa siitä, mikä on muuttunut, ilmoittamalla muutoksesta kolmannen osapuolen järjestelmälle. Kolmannen osapuolen järjestelmä voi sitten hakea varsinaiset tiedot Provetin REST API:n avulla.
REST API on viestintämenetelmä, jolla kolmannen osapuolen sovellukset voivat käyttää, muokata tai lisätä Provetissa olevia tietoja ohjelmallisesti. Provetin REST API tarjoaa suurimman osan Provetin keskeisistä tiedoista muiden järjestelmien luettavaksi tai käsiteltäväksi.
Provetin verkkokoukkujen & REST API:n yhdistelmä luo ainutlaatuisia mahdollisuuksia integroitujen ratkaisujen rakentamiseen. Kaikki muiden järjestelmien toimittajat, jotka tuntevat nämä tekniikat, voivat helposti integroida Provet-eläinlääkärin vastaanotonhallintajärjestelmässä olevia tietoja hyödyntämällä näitä tekniikoita.
Ennen kuin voit aloittaa Provetin 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
Verkkokoukut voidaan määrittää ja ottaa käyttöön osoitteessa Asetukset > Yleistä > Integraatiot > Verkkokoukut tai API-päätepisteen kautta. Jos integraatiosi käyttää webhookeja, suosittelemme webhookien luomisen automatisointia API:n kautta. Katso kehittäjäsivustoltamme ajantasainen Luettelo webhook-triggereistä ja yksityiskohtainen Webhooks-opas.
REST API
Provet tarjoaa REST API:n, jonka avulla voidaan käyttää Provetiin tallennettuja tietoja. API käyttää OAuth 2.0 -todennusta. Tiedot palautetaan JSON -muodossa.
REST-API:n käyttämiseen tarvitaan integraatiomalli.
Provet API tukee kahta apurahatyyppiä: Valtuutuskoodi ja Client Credentials.
Valtuutuskoodia käytetään käyttöliittymien todentamiseen ja tapauksissa, joissa käyttäjät käyttävät sovellusrajapintaa omana itsenään. PKCE on tuettu ja erittäin suositeltava. Julkisten asiakkaiden PITÄÄ käyttää PKCE:tä.
Client Credentials -tunnuksia käytetään backend-yhteyksissä, joissa palvelut kommunikoivat suoraan toistensa kanssa ilman käyttäjän toimenpiteitä.
REST API:ta voidaan käyttää käyttämällä URL-osoitetta, joka on koottu seuraavasti: https://<provet_environment>/<provet_id>/api/0.1/
<provet_environment> URL-osoite vaihtelee hieman kussakin ympäristössä. Se voi olla esimerkiksi
provetcloud.com EU-ympäristöä varten
us.provetcloud.com Yhdysvaltain ympäristöön
URL-osoitteessa <provet_id> on yrityksesi Provet-instanssin yksilöllinen tunnus.
Koko URL-osoite näkyy aina Provetin API-asetuksissa Asetukset > Integraatiot > Avoin API-yhteys.
Provet REST API on selattavissa osoitteessa https://www.django-rest-framework.org/topics/browsable-api/ , minkä ansiosta kehittäjien pitäisi pystyä arvioimaan tiedonsiirtomahdollisuuksia.
Integrointisovelluksen lisääminen Provetissa
Kun malli on luotu, integraatio näkyy Provetin integraatioluettelossa: Asetukset > Integraatiot > Avaa API-yhteys > Lisää sovellus. Luettelossa luetellaan käytettävissä olevat integraatiot ja siinä on lyhyt kuvaus siitä, mitä kukin integraatio tekee. Jos integraatiolla on lisäasennusohjeita, ne näkyvät myös luettelossa.
Integraatioilla voi olla rajoitettu näkyvyys: ne voidaan rajoittaa koskemaan vain tiettyjä Provetin vuokralaisia tai tiettyjä maita. Integraation tarjoava kolmas osapuoli voi valita, kuinka laajasti integraation on oltava näkyvissä vuokralaisille. Kun rajoituksia on olemassa, sovellus näkyy Integraatioluettelossa vain niissä vuokralaisissa / niissä maissa, joissa se on sallittu.
Uuden asiakkaan rekisteröinnin vaihtoehdot
Aina kun uusi asiakas rekisteröityy käyttämään integraatiota eli valitsee sen Provetin 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:
sähköpostiosoite
kytkennät URL
Kun integraatiota käytetään vain yhdessä Provet-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 Provetiin, 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." }, "departments": { "type": "array", "items": { "type": "integer" }, "description": "Array of department IDs that have enabled this integration.", "examples": [[1, 2, 3]] }, "added_department": { "type": "integer", "description": "ID of the department that enabled this integration.", "examples": [3] }, "removed_department": { "type": "integer", "description": "ID of the department that disabled this integration.", "examples": [3] } }}Luvat
Kun uusi integraatiosovellus lisätään Provetiin, 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 käyttäen Virtuaalinen -suodatinta. Käyttöoikeusryhmällä on sama nimi kuin integraatiolla.
Provet 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ä Provetin tukeen saadaksesi lupamallin integraatiomalliisi.
Kun käyttöoikeusmalleja muutetaan, Provetin 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 API -kaaviosta, mitä oikeuksia kukin päätepiste tarvitsee. Katso myös Käyttöoikeuksien tarkastelu ja hallinta.
Osastokohtainen integrointi
Provet-ympäristöissä, joissa on useita klinikkapaikkoja, integraatio voidaan ottaa käyttöön tai poistaa käytöstä erikseen kunkin klinikkapaikan osalta. Tämä asetus on vain informatiivinen, eikä se luo ylimääräisiä asiakastietoja. Luettelo klinikkapaikoista, joissa integraatio on käytössä, sisältyy webhookin datan hyötykuormaan.
Aina kun integraatio otetaan käyttöön tai poistetaan käytöstä klinikan sijainnin osalta, lähetetään uusi webhook, joka sisältää seuraavat tiedot:
Kaikki tällä hetkellä käytössä olevat osastot
Lisätty osasto
Poistettu osasto
Tätä toimintoa ei yleensä tarvita. Jos tarvitset tietoa siitä, mitkä klinikkapaikat käyttävät tai eivät käytä integraatiotasi samassa Provet-vuokralaisessa, ota yhteys Provetin tukeen ja kysy, voisitko ottaa tämän ominaisuuden käyttöön integraatiossasi.
Provetissa klinikkapaikkakohtaiset integraatiot näyttävät rivin lopussa Enable (Ota käyttöön ) tai Disable (Poista käytöstä ) -painikkeen. Näin käyttäjät voivat ottaa integraation käyttöön tai poistaa sen käytöstä sen klinikan sijainnin osalta, jota he parhaillaan tarkastelevat. Kun integraatio on lisätty, se on otettava käyttöön erikseen jokaisessa klinikkapaikassa. Klinikkapaikat, joissa integraatio on käytössä, näkyvät Disable -painikkeen vieressä. Jos integraatio ei tue klinikkakohtaista aktivointia, se aktivoidaan automaattisesti organisaatiotasolla.
Integraation vapauttaminen
Kun olet kehittänyt ja testannut integraatiosi ja haluat julkaista sen julkiseen käyttöön, ota yhteyttä Provetin tukeen, jotta integraatiomallisi näkyy kaikissa Provetin instansseissa. Jos integraatiosi ei ole asiakaskohtainen ja sitä on tarkoitus käyttää monissa Provet-instansseissa monien käyttäjien toimesta, on joitakin vaatimuksia, jotka on täytettävä ennen käyttöönottoa. Näiden vaatimusten tarkoituksena on helpottaa integraation käyttöönottoa ja antaa Provetin tuelle tarvittavat tiedot.
Luo lyhyt video integraatiostasi: miten sitä käytetään ja mitä se tekee.
Luo käyttöönotto-ohje, joka sisältää kaikki manuaaliset vaiheet, joita Provet-käyttäjä tarvitsee integraatiosi käyttöönotossa. Vaiheet voivat sisältää myös järjestelmässäsi tarvittavat toimenpiteet.
Katso tämä esimerkki palvelukseenotto-oppaasta. Esimerkkiintegraatiossa käytetään yhtä webhookia, mutta integraatiosi saattaa tarvita muita asetuksia, kuten mukautetun kentän jne.
Toimita meille sekä video että käyttöönotto-opas ja kerro meille, millä markkinoilla / missä maissa integraatiosi pitäisi näkyä.
Auttaa onboarding-prosessin automatisoinnissa ja vähentämään inhimillisiä virheitä, suosittelemme käyttämään seuraavia toimintoja julkisissa integraatioissa, joita käytetään monilla Provet-asiakkuuksilla:
Lupamalli
Kytkennän URL-osoite sähköposti-ilmoituksen sijaan
Verkkokoukkujen ja mukautettujen painikkeiden luominen API-päätepisteiden kautta (tarvittaessa).
Jos nämä ominaisuudet eivät ole käytössäsi, ota yhteyttä Provetin asiakastukeen lupamallin ja kytkentä-URL:n määrittämiseksi sinulle. Jos sinulla on erityinen syy käyttää ilmoitussähköpostia, ilmoita siitä meille.
Sijaintiin perustuvaa laskutusta käyttäviltä kumppaneilta vaaditaan klinikkakohtainen sijaintiominaisuus. Se on määritettävä, testattava ja sisällytettävä käyttöönotto-ohjeisiin ennen kuin integraatio voidaan ottaa käyttöön.