Integrering av tredjepartsapplikationer med Provet Cloud

Exempel på integrationslösning

Webhooks

REST API

Lägg till en integrationsapplikation i Provet Cloud

Alternativ i en ny klientregistrering

Behörigheter

Frigörande av en integration

Provet Cloud veterinärpraktikhanteringssystem kan integreras med tredjepartsapplikationer med hjälp av verktyg som kallas REST API och webhooks.

Webhooks finns tillgängliga i Provet Cloud för att skicka meddelanden till tredjepartssystem om tillägg eller ändringar i data i Provet Cloud. Webhooks överför inte de faktiska ändrade uppgifterna, utan istället överför de informationen om vad som har ändrats genom att helt enkelt meddela tredjepartssystemet om ändringen. De faktiska uppgifterna kan sedan hämtas av tredjepartssystemet genom att använda REST API för Provet Cloud.

REST API är en kommunikationsmetod för att komma åt, redigera eller lägga till data som finns i Provet Cloud programmatiskt av någon tredjepartsapplikation. Provet Clouds REST API erbjuder de flesta av de viktigaste Provet Cloud-data som kan läsas eller manipuleras av andra system.

Kombinationen av Provet Cloud webhooks & REST API skapar unika möjligheter för att bygga integrerade lösningar. Alla leverantörer av andra system som känner till dessa tekniker kan enkelt integrera med de data som finns i Provet Cloud veterinärpraktikhanteringssystem genom att använda dessa tekniker.

Innan du kan börja använda Provet Cloud API:er måste vi aktivera åtkomst till testmiljön för dig. Vänligen kontakta vår Partner Development Manager för att komma igång.

Vi kommer att skapa en testmiljö som du kan komma åt under den inledande utvecklingen. Vi kommer också att skapa en integrationsmall med önskad OAuth2 grant-typ för att du ska få tillgång till din testmiljö. Detta gör att du kan utveckla och testa din kod med vårt API.

Se vår utvecklarsida för API-dokumentation, API-schema och annan värdefull information som hjälper dig med din utveckling.

Webhooks konfigureras och aktiveras i Inställningar > Allmänt > Integrationer > Webhooks. Exempel: "konsultation_id=123".

Provet Cloud tillhandahåller REST API för att möjliggöra åtkomst till de data som lagras i Provet Cloud. API:et använder OAuth 2.0-autentisering. Data returneras i formatet JSON.

Provet Cloud REST API är bläddringsbart, vilket bör ge en god möjlighet för utvecklare att utvärdera möjligheterna till dataöverföring.

När mallen är skapad kan integrationen ses i integrationskatalogen i Provet Cloud: Inställningar > Integrationer > Öppen API-åtkomst > Lägg till applikation. Katalogen listar de tillgängliga integrationerna och har en kort beskrivning av vad varje integration gör. Om integrationen har fler installationsinstruktioner visas detta också i katalogen.

Integrationerna kan ha begränsad synlighet: de kan begränsas till endast vissa Provet Cloud-hyresgäster eller i vissa länder. Den tredje part som tillhandahåller integrationen kan välja i vilken utsträckning integrationen behöver vara synlig för hyresgästerna. När det finns begränsningar visas applikationen i Integration Catalogue endast på de hyresgäster / i de länder som den är tillåten på.

Varje gång en ny kund registrerar sig för att använda en integration, dvs. väljer den från integrationskatalogen i Provet Cloud (Add Application), skickas unika kunduppgifter till integrationsleverantören. Det finns två alternativ för att meddela en registrering av en ny klient som kan väljas när du skapar en integrationsmall:

När integrationen endast används på en Provet Cloud-instans är e-post ett bra val: då kan den person som tar emot e-postmeddelandet konfigurera autentiseringsuppgifterna för integrationen och börja använda den. När integrationen används i stor utsträckning rekommenderas å andra sidan hookup URL och automatisering av att lägga till en ny klient.

Hookup URL lyssnar efter eventuella automatiska meddelanden om nya kunder. När en ny klient lägger till integrationen i Provet Cloud skickar orkestreringsverktyget automatiskt ett JSON-meddelande till den angivna URL:en. Det finns inget behov av mänsklig interaktion, eftersom integrationen automatiskt analyserar den nya klienten från JSON-meddelandet och lägger till deras autentiseringsuppgifter i sin klienttabell.

JSON-schema för de data som skickas för nya integrationsregistreringar:

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

När en ny integrationsapplikation läggs till i Provet Cloud skapas automatiskt en virtuell användare och en behörighetsgrupp för integrationen. Den virtuella användaren heter Integration <Integration name> och finns i Settings > Users med hjälp av filtret Virtual. Behörighetsgruppen har samma namn som integrationen.

Provet Cloud stöder automatiserad behörighetshantering, vilket minskar det manuella arbetet och säkerställer konsekvens. Den här funktionen kallas "behörighetsmall" och läggs till i integrationsmallen. Kontakta Provet Clouds support för att få din behörighetsmall på din integrationsmall.

När behörighetsmallar ändras uppdateras den tillhörande behörighetsgruppen i Provet Cloud automatiskt så att den matchar den senaste mallen. De tillagda behörigheterna inkluderas och borttagna behörigheter exkluderas för att säkerställa synkronisering.

Om en behörighetsmall inte används har den som standard samma behörigheter som behörighetsgruppen Users.

Om en integration kräver andra behörigheter (vissa endpoints nekas eller om du vill begränsa behörigheterna) måste behörigheterna redigeras. Kontrollera från Provet Cloud API schema vilka behörigheter varje endpoint behöver. Se även Visa och hantera användarbehörigheter.

Anpassade integrationer

https://developers.provetcloud.com/

Exempel på installationsguide för integration

Exempel på integrationslösning