Integrazione di applicazioni di terze parti con Provet Cloud

Esempio di soluzione di integrazione

Ganci web

API REST

Aggiungere un'applicazione di integrazione in Provet Cloud

Opzioni nella registrazione di un nuovo cliente

Permessi

Rilascio di un'integrazione

Il sistema di gestione degli studi veterinari Provet Cloud può essere integrato con applicazioni di terze parti utilizzando strumenti chiamati REST API e webhook.

I webhook sono disponibili in Provet Cloud per inviare notifiche a sistemi di terze parti su aggiunte o modifiche dei dati all'interno di Provet Cloud. I webhook non trasferiscono i dati effettivamente modificati, bensì le informazioni su ciò che è cambiato, notificando semplicemente la modifica al sistema di terze parti. I dati effettivi possono poi essere recuperati dal sistema di terze parti utilizzando l'API REST di Provet Cloud.

REST API è un metodo di comunicazione per accedere, modificare o aggiungere ai dati residenti in Provet Cloud in modo programmatico da qualsiasi applicazione di terze parti. L'API REST di Provet Cloud offre la possibilità di leggere o manipolare la maggior parte dei dati chiave di Provet Cloud da parte di altri sistemi.

La combinazione di webhooks di Provet Cloud & REST API crea possibilità uniche per la creazione di soluzioni integrate. Qualsiasi fornitore di altri sistemi che abbia familiarità con queste tecnologie può facilmente integrarsi con i dati residenti nel sistema di gestione degli studi veterinari Provet Cloud utilizzando queste tecnologie.

Prima di poter iniziare a utilizzare le API di Provet Cloud, è necessario abilitare l'accesso all'ambiente di prova. Contattate il nostro Partner Development Manager per iniziare.

Creeremo un ambiente di prova a cui potrete accedere durante lo sviluppo iniziale. Creeremo anche un modello di integrazione con il tipo di concessione OAuth2 desiderato per l'accesso all'ambiente di prova. Questo vi permetterà di sviluppare e testare il vostro codice con la nostra API.

Consultate la nostra pagina per gli sviluppatori per la documentazione dell'API, lo schema dell'API e altre preziose informazioni per aiutarvi nello sviluppo.

I webhook sono configurati e abilitati in Impostazioni > Generale > Integrazioni > Webhook. Esempio: "consultation_id=123".

Provet Cloud fornisce l'API REST per consentire l'accesso ai dati archiviati in Provet Cloud. L'API utilizza l'autenticazione OAuth 2.0. I dati vengono restituiti nel formato JSON.

Provet Cloud REST API è navigabile, che dovrebbe consentire agli sviluppatori di valutare le possibilità di trasferimento dei dati.

Una volta creato il modello, l'integrazione è visibile nel catalogo delle integrazioni di Provet Cloud: Impostazioni > Integrazioni > Accesso API aperto > Aggiungi applicazione. Il catalogo elenca le integrazioni disponibili e contiene una breve descrizione delle funzioni di ciascuna integrazione. Se l'integrazione ha ulteriori istruzioni per l'impostazione, anche queste vengono visualizzate nel catalogo.

Le integrazioni possono avere una visibilità limitata: possono essere riservate solo a determinati tenant di Provet Cloud o in determinati Paesi. La terza parte che fornisce l'integrazione può scegliere in che misura l'integrazione deve essere visibile sui tenant. In caso di restrizioni, l'applicazione viene visualizzata nel Catalogo delle Integrazioni solo su quei tenant o in quei Paesi in cui è consentita.

Ogni volta che un nuovo cliente si registra per utilizzare un'integrazione, ossia la sceglie dal catalogo delle integrazioni in Provet Cloud (Aggiungi applicazione), le credenziali uniche del cliente vengono inviate al fornitore dell'integrazione. Esistono due opzioni per notificare la registrazione di un nuovo cliente, che possono essere scelte quando si crea un modello di integrazione:

Quando l'integrazione viene utilizzata solo su un'istanza di Provet Cloud, l'e-mail è una buona scelta: la persona che riceve l'e-mail può configurare i dettagli di autenticazione all'integrazione e iniziare a utilizzarla. D'altra parte, quando l'integrazione è ampiamente utilizzata, si consiglia di utilizzare l'URL di hookup e di automatizzare l'aggiunta di un nuovo cliente.

L'URL di aggancio è in ascolto per eventuali notifiche automatiche di nuovi clienti. Quando un nuovo cliente aggiunge l'integrazione in Provet Cloud, lo strumento di orchestrazione invia automaticamente un messaggio JSON all'URL indicato. Non è necessaria alcuna interazione umana, poiché l'integrazione analizza automaticamente il nuovo cliente dal messaggio JSON e aggiunge le sue credenziali alla tabella dei clienti.

Schema JSON per i dati inviati per le registrazioni di nuove integrazioni:

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

Quando si aggiunge una nuova applicazione di integrazione a Provet Cloud, vengono creati automaticamente un utente virtuale e un gruppo di autorizzazioni per l'integrazione. L'utente virtuale si chiama Integrazione <Nome dell'integrazione> e può essere trovato in Impostazioni > Utenti utilizzando il filtro Virtuale. Il gruppo di autorizzazioni ha lo stesso nome dell'integrazione.

Provet Cloud supporta la gestione automatizzata dei permessi, riducendo lo sforzo manuale e garantendo la coerenza. Questa funzione si chiama "modello di autorizzazione" e viene aggiunta al modello di integrazione. Contattare il supporto di Provet Cloud per ottenere il modello di autorizzazione sul modello di integrazione.

Quando i modelli di autorizzazione vengono modificati, il gruppo di autorizzazioni associato in Provet Cloud viene automaticamente aggiornato per corrispondere al modello più recente. I permessi aggiunti vengono inclusi e quelli rimossi vengono esclusi per garantire la sincronizzazione.

Se un modello di autorizzazione non viene utilizzato, ha gli stessi permessi di default del gruppo di autorizzazioni Users.

Se un'integrazione richiede autorizzazioni diverse (alcuni endpoint sono negati o si desidera limitare le autorizzazioni), le autorizzazioni devono essere modificate. Controllare dallo schema Provet Cloud API quali autorizzazioni sono necessarie per ogni endpoint. Vedere anche Visualizzare e gestire le autorizzazioni degli utenti.

Integrazioni personalizzate

https://developers.provetcloud.com/

Esempio di guida alla configurazione dell'integrazione

Esempio di soluzione di integrazione