Integration af tredjepartsapplikationer med Provet Cloud

Introduktion

Provet Cloud veterinary practice management system kan integreres med tredjepartsapplikationer ved hjælp af værktøjer kaldet REST API og webhooks.

Webhooks er tilgængelige i Provet Cloud til at sende meddelelser til tredjepartssystemer om tilføjelser eller ændringer i data i Provet Cloud. Webhooks overfører ikke de faktiske ændrede data, men i stedet overfører de oplysninger om, hvad der er ændret, ved blot at underrette tredjepartssystemet om ændringen. De faktiske data kan derefter hentes af tredjepartssystemet ved at bruge Provet Clouds REST API.

REST API er en kommunikationsmetode til at få adgang til, redigere eller tilføje data i Provet Cloud programmatisk af enhver tredjepartsapplikation. Provet Clouds REST API gør det muligt for andre systemer at læse eller manipulere de fleste af Provet Clouds nøgledata.

Kombinationen af Provet Cloud webhooks & REST API skaber unikke muligheder for at bygge integrerede løsninger. Enhver leverandør af andre systemer, der er bekendt med disse teknologier, kan nemt integrere med de data, der ligger i Provet Clouds veterinærpraksissystem, ved at bruge disse teknologier.

Før du kan begynde at bruge Provet Cloud API'er, er vi nødt til at give dig adgang til testmiljøet. Kontakt venligst vores Partner Development Manager for at komme i gang.

Vi opretter et testmiljø, som du kan få adgang til under den indledende udvikling. Vi opretter også en integrationsskabelon med den ønskede OAuth2-tildelingstype, så du kan få adgang til dit testmiljø. Dette giver dig mulighed for at udvikle og teste din kode med vores API.

Se vores udviklerside for API-dokumentation, API-skema og andre værdifulde oplysninger, der kan hjælpe dig med din udvikling.

Webhooks

Webhooks konfigureres og aktiveres i Indstillinger > Generelt > Integrationer > Webhooks. Eksempel: "konsultation_id=123".

REST API

Provet Cloud stiller REST API til rådighed for at give adgang til de data, der er lagret i Provet Cloud. API'en bruger OAuth 2.0-godkendelse. Dataene returneres i formatet JSON.

  • For at få adgang til REST API skal du bruge en integrationsskabelon.

    • Provet Cloud API understøtter to bevillingstyper: Autorisationskode og Klientlegitimation.

      • Authorization Code bruges til at autentificere brugergrænseflader og tilfælde, hvor brugere får adgang til API'en som sig selv. PKCE understøttes og anbefales på det kraftigste. Offentlige klienter SKAL bruge PKCE.

      • Client Credentials bruges til backend-forbindelse, hvor tjenester kommunikerer direkte med hinanden uden nogen brugerhandlinger.

  • REST-API'en kan tilgås ved hjælp af en URL, der er sammensat på følgende måde: https://<provet_environment>/<provet_id>/api/0.1/

    • <provet_environment> URL er lidt forskellig for hvert miljø. Den kan for eksempel være

      • provetcloud.com for EU-miljø

      • us.provetcloud.com for USA-miljøet

    • I URL'en <provet_id> er det unikke id for Provet Cloud-instansen for din virksomhed.

    • Hele URL'en vises altid i API-indstillingerne i Provet Cloud Indstillinger > Integrationer > Åben API-adgang.

Provet Cloud REST API er , der kan gennemses, hvilket burde give udviklere god mulighed for at evaluere mulighederne for dataoverførsel.

Tilføj en integrationsapplikation i Provet Cloud

Når skabelonen er oprettet, kan integrationen ses i integrationskataloget i Provet Cloud: Indstillinger > Integrationer > Åben API-adgang > Tilføj applikation. Kataloget viser de tilgængelige integrationer og har en kort beskrivelse af, hvad hver integration gør. Hvis integrationen har flere opsætningsinstruktioner, vises det også i kataloget.

9947060702108-mceclip0.png

Integrationerne kan have begrænset synlighed: De kan begrænses til kun at gælde for visse Provet Cloud-brugere eller i visse lande. Den tredjepart, der leverer integrationen, kan vælge, hvor meget integrationen skal være synlig på lejerne. Når der er begrænsninger, vises applikationen i Integration Catalogue kun på de lejere/i de lande, hvor den er tilladt.

Indstillinger i en ny klientregistrering

Hver gang en ny klient registrerer sig for at bruge en integration, dvs. vælger den fra integrationskataloget i Provet Cloud (Add Application), sendes der unikke klientoplysninger til integrationsudbyderen. Der er to muligheder for at underrette om en registrering af en ny klient, som kan vælges, når man opretter en integrationsskabelon:

  • e-mail

  • opkobling URL

Når integrationen kun bruges på én Provet Cloud-instans, er e-mail et godt valg: Så kan den person, der modtager e-mailen, konfigurere godkendelsesoplysningerne til integrationen og begynde at bruge den. På den anden side, når integrationen er meget udbredt, anbefales det at tilslutte URL'en og automatisere tilføjelsen af en ny klient.

Hookup URL lytter efter eventuelle automatiske meddelelser om nye klienter. Når en ny klient tilføjer integrationen i Provet Cloud, sender orkestreringsværktøjet automatisk en JSON-meddelelse til den givne URL. Der er ikke behov for nogen menneskelig interaktion, når integrationen automatisk analyserer den nye klient fra JSON-meddelelsen og tilføjer deres legitimationsoplysninger til deres klienttabel.

JSON-skema for de data, der sendes til nye integrationsregistreringer:

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

Tilladelser

Når en ny integrationsapplikation tilføjes til Provet Cloud, oprettes der automatisk en virtuel bruger og en rettighedsgruppe til integrationen. Den virtuelle bruger hedder Integration <Integration name>, og den kan findes i Settings > Users ved hjælp af filteret Virtual. Tilladelsesgruppen har samme navn som integrationen.

Provet Cloud understøtter automatiseret rettighedsstyring, hvilket reducerer den manuelle indsats og sikrer konsistens. Denne funktion kaldes "tilladelsesskabelon", og den tilføjes til integrationsskabelonen. Kontakt Provet Clouds support for at få din tilladelsesskabelon på din integrationsskabelon.

Når tilladelsesskabeloner ændres, opdateres den tilknyttede tilladelsesgruppe i Provet Cloud automatisk, så den matcher den seneste skabelon. De tilføjede tilladelser medtages, og fjernede tilladelser udelukkes for at sikre synkronisering.

Hvis der ikke bruges en rettighedsskabelon, har den som standard de samme tilladelser som rettighedsgruppen Users.

Hvis en integration kræver andre tilladelser (nogle slutpunkter er afvist, eller du vil begrænse tilladelserne), skal tilladelserne redigeres. Se på Provet Cloud API schema, hvilke tilladelser hvert slutpunkt har brug for. Se også Se og administrer brugerrettigheder.

Frigivelse af en integration

Når du har udviklet og testet din integration og ønsker at frigive den til offentlig brug, skal du kontakte Provet Cloud-support for at gøre din integrationsskabelon synlig for alle Provet Cloud-instanser. Hvis din integration ikke er kundespecifik, og det er meningen, at den skal bruges i mange Provet Cloud-instanser af mange brugere, er der nogle krav, der skal opfyldes, før du går live. Disse krav er beregnet til at gøre integrationens onboarding lettere og give de nødvendige oplysninger til Provet Cloud-support.

  1. Lav en kort video om din integration: hvordan man bruger den, og hvad den gør.

  2. Opret en onboarding-instruktion, der indeholder alle de manuelle trin, som Provet Cloud-brugeren skal udføre for at tage din integration i brug. Trinene kan også omfatte de handlinger, der er nødvendige i dit system.

  3. Giv os både videoen og onboarding-guiden, og fortæl os, på hvilke markeder / i hvilke lande din integration skal være synlig.

Opdateret

Var denne artikel en hjælp?

1 ud af 1 fandt dette nyttigt

Har du flere spørgsmål? Indsend en anmodning

Kommentarer

0 kommentarer

Log ind for at kommentere.