Integrering av tredjepartsapplikasjoner med Provet Cloud

Innledning

Provet Cloud veterinærpraksisadministrasjonssystem kan integreres med tredjepartsapplikasjoner ved hjelp av verktøy som kalles REST API og webhooks.

Webhooks er tilgjengelig i Provet Cloud for å sende varsler til tredjepartssystemer om tilføyelser eller endringer i dataene i Provet Cloud. Webhooks overfører ikke de faktiske endrede dataene, men i stedet overfører de informasjon om hva som har endret seg ved å varsle tredjepartssystemet om endringen. De faktiske dataene kan deretter hentes av tredjepartssystemet ved å bruke REST API i Provet Cloud.

REST API er en kommunikasjonsmetode for å få tilgang til, redigere eller legge til data som ligger i Provet Cloud programmatisk av en tredjepartsapplikasjon. Provet Clouds REST API gjør det mulig for andre systemer å lese eller manipulere de fleste av Provet Clouds nøkkeldata.

Kombinasjonen av Provet Clouds webhooks & REST API skaper unike muligheter for å bygge integrerte løsninger. Alle leverandører av andre systemer som er kjent med disse teknologiene, kan enkelt integrere med dataene i Provet Cloud veterinærpraksisadministrasjonssystem ved å bruke disse teknologiene.

Før du kan begynne å bruke Provet Cloud API-er, må vi gi deg tilgang til testmiljøet. Ta kontakt med vår Partner Development Manager for å komme i gang.

Vi oppretter et testmiljø som du får tilgang til under den innledende utviklingen. Vi oppretter også en integrasjonsmal med ønsket OAuth2-tildelingstype for deg med tilgang til testmiljøet ditt. Dette gjør at du kan utvikle og teste koden din med API-et vårt.

Se vår utviklerside for API-dokumentasjon, API-skjemaer og annen verdifull informasjon som kan hjelpe deg med utviklingen din.

Webhooks

Webhooks konfigureres og aktiveres i Innstillinger > Generelt > Integrasjoner > Webhooks. Eksempel: "konsultasjon_id=123".

REST API

Provet Cloud tilbyr REST API for å gi tilgang til dataene som er lagret i Provet Cloud. API-et bruker OAuth 2.0-autentisering. Dataene returneres i formatet JSON.

  • For å få tilgang til REST API trenger du en integrasjonsmal.

    • Provet Cloud API støtter to typer tillatelser: Autorisasjonskode og Klientlegitimasjon.

      • Authorization Code brukes til autentisering av brukergrensesnitt og i tilfeller der brukere får tilgang til API-et som seg selv. PKCE støttes og anbefales på det sterkeste. Offentlige klienter MÅ bruke PKCE.

      • Client Credentials brukes for backend-tilkobling der tjenester kommuniserer direkte med hverandre uten brukerhandlinger.

  • REST API kan nås ved å bruke en URL som er satt sammen på følgende måte: https://<provet_environment>/<provet_id>/api/0.1/

    • <provet_environment> URL varierer litt for hvert miljø. Den kan for eksempel være

      • provetcloud.com for EU-miljø

      • us.provetcloud.com for USA-miljø

    • I URL-en <provet_id> er den unike id-en til Provet Cloud-forekomsten for din bedrift

    • Hele URL-adressen vises alltid i API-innstillingene i Provet Cloud Innstillinger > Integrasjoner > Åpen API-tilgang.

Provet Cloud REST API er som kan bla gjennom, noe som bør gi utviklere en god mulighet til å evaluere mulighetene for dataoverføring.

Legg til en integrasjonsapplikasjon i Provet Cloud

Når malen er opprettet, kan integrasjonen vises i integrasjonskatalogen i Provet Cloud: Innstillinger > Integrasjoner > Åpne API-tilgang > Legg til applikasjon. Katalogen inneholder en liste over tilgjengelige integrasjoner og en kort beskrivelse av hva hver integrasjon gjør. Hvis integrasjonen har flere oppsettinstruksjoner, vises dette også i katalogen.

9947060702108-mceclip0.png

Integrasjonene kan ha begrenset synlighet: De kan begrenses til bare visse Provet Cloud-brukere eller i visse land. Tredjeparten som leverer integrasjonen, kan velge hvor mye integrasjonen skal være synlig på leietakerne. Når det er begrensninger, vises applikasjonen i integrasjonskatalogen bare på de leietakerne / i de landene den er tillatt på.

Alternativer i en ny klientregistrering

Hver gang en ny klient registrerer seg for å bruke en integrasjon, dvs. velger den fra integrasjonskatalogen i Provet Cloud (Legg til applikasjon), sendes unike klientopplysninger til integrasjonsleverandøren. Det finnes to alternativer for å varsle om registrering av en ny klient som kan velges når du oppretter en integrasjonsmal:

  • e-post

  • oppkobling URL

Når integrasjonen bare brukes på én Provet Cloud-instans, er e-post et godt valg: Da kan personen som mottar e-posten, konfigurere autentiseringsdetaljene til integrasjonen og begynne å bruke den. Når integrasjonen derimot brukes mye, anbefales det å koble til URL-adressen og automatisere det å legge til en ny klient.

Hookup URL lytter etter automatiske varsler om nye klienter. Når en ny klient legger til integrasjonen i Provet Cloud, sender orkestreringsverktøyet automatisk en JSON-melding til den gitte URL-adressen. Det er ikke behov for noen menneskelig interaksjon, da integrasjonen automatisk analyserer den nye klienten fra JSON-meldingen og legger til legitimasjonen deres i klienttabellen.

JSON-skjema for dataene som sendes for nye integrasjonsregistreringer:

{
"$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."
     }
 }
}

Tillatelser

Når en ny integrasjonsapplikasjon legges til i Provet Cloud, opprettes det automatisk en virtuell bruker og en rettighetsgruppe for integrasjonen. Den virtuelle brukeren heter Integrasjon <Integrasjonsnavn> og finnes i Innstillinger > Brukere ved hjelp av filteret Virtuell. Tillatelsesgruppen har samme navn som integrasjonen.

Provet Cloud støtter automatisert administrasjon av tillatelser, noe som reduserer manuelt arbeid og sikrer konsistens. Denne funksjonen kalles "rettighetsmal", og den legges til i integrasjonsmalen. Kontakt Provet Cloud-support for å få lagt til en rettighetsmal i integrasjonsmalen din.

Når rettighetsmaler endres, oppdateres den tilknyttede rettighetsgruppen i Provet Cloud automatisk slik at den samsvarer med den nyeste malen. Tillatelser som legges til, inkluderes, og tillatelser som fjernes, ekskluderes for å sikre synkronisering.

Hvis en rettighetsmal ikke brukes, har den som standard de samme rettighetene som rettighetsgruppen Users.

Hvis en integrasjon krever andre tillatelser (noen endepunkter er nektet eller du ønsker å begrense tillatelsene), må tillatelsene redigeres. Sjekk i Provet Cloud API-skjemaet hvilke tillatelser hvert endepunkt trenger. Se også Vis og administrer brukerrettigheter.

Frigjøring av en integrasjon

Når du har utviklet og testet integrasjonen din og ønsker å lansere den for offentlig bruk, kan du kontakte Provet Cloud-support for å få integrasjonsmalen din synlig for alle Provet Cloud-instanser. Hvis integrasjonen din ikke er kundespesifikk og er ment å brukes i mange Provet Cloud-instanser av mange brukere, er det noen krav som må oppfylles før du går live. Disse kravene er ment å gjøre integrasjonen enklere å ta i bruk og gi nødvendig informasjon til Provet Cloud-støtte.

  1. Lag en kort video om integrasjonen din: hvordan du bruker den og hva den gjør.

  2. Lag en onboarding-instruksjon som inneholder alle de manuelle trinnene som Provet Cloud-brukeren trenger for å ta integrasjonen i bruk. Trinnene kan også inkludere handlingene som trengs i systemet ditt.

  3. Gi oss både videoen og onboarding-veiledningen, og fortell oss hvilke markeder/land integrasjonen skal være synlig i.

Oppdatert

Var denne artikkelen nyttig?

1 av 1 syntes dette var nyttig

Har du flere spørsmål? Send oss en henvendelse

Kommentarer

0 kommentarer

Logg på hvis du vil legge inn en kommentar.