Integración de aplicaciones de terceros con Provet Cloud

Ejemplo de solución de integración

Webhooks

API REST

Añadir una aplicación de integración en Provet Cloud

Opciones en el registro de un nuevo cliente

Permisos

Liberar una integración

El sistema de gestión de consultas veterinarias Provet Cloud puede integrarse con aplicaciones de terceros mediante herramientas denominadas REST API y webhooks.

Webhooks están disponibles en Provet Cloud para enviar notificaciones a sistemas de terceros sobre adiciones o cambios en los datos dentro de Provet Cloud. Los webhooks no transfieren los datos reales modificados, sino que transfieren la información sobre lo que ha cambiado simplemente notificando el cambio al sistema de terceros. Los datos reales pueden ser obtenidos por el sistema de terceros mediante la utilización de la API REST de Provet Cloud.

REST API es un método de comunicación para acceder, editar o añadir a los datos que residen en Provet Cloud de forma programática por cualquier aplicación de terceros. La API REST de Provet Cloud ofrece la mayoría de los datos clave de Provet Cloud para ser leídos o manipulados por otros sistemas.

La combinación de Provet Cloud webhooks & REST API crea posibilidades únicas para la construcción de soluciones integradas. Cualquier proveedor de otros sistemas familiarizado con estas tecnologías puede integrarse fácilmente con los datos que residen en el sistema de gestión de la práctica veterinaria Provet Cloud utilizando estas tecnologías.

Antes de que pueda empezar a utilizar las APIs de Provet Cloud, necesitamos habilitar el acceso al entorno de pruebas para usted. Por favor, póngase en contacto con nuestro Partner Development Manager para empezar.

Crearemos un entorno de prueba para que pueda acceder durante el desarrollo inicial. También le crearemos una plantilla de integración con el tipo de concesión OAuth2 deseado para que tenga acceso a su entorno de prueba. Esto le permitirá desarrollar y probar su código con nuestra API.

Visite nuestra página para desarrolladores para consultar la documentación de la API, el esquema de la API y otra información valiosa que le ayudará en su desarrollo.

Los Webhooks se configuran y habilitan en Configuración > General > Integraciones > Webhooks. Ejemplo: "consultation_id=123".

Provet Cloud proporciona la API REST para permitir el acceso a los datos almacenados en Provet Cloud. La API utiliza la autenticación OAuth 2.0. Los datos se devuelven en el formato JSON.

Provet Cloud REST API es navegable, lo que debería permitir una buena posibilidad para que los desarrolladores evalúen las posibilidades de transferencia de datos.

Una vez creada la plantilla, la integración puede verse en el catálogo de integraciones en Provet Cloud: Ajustes > Integraciones > Acceso API abierto > Añadir aplicación. El catálogo enumera las integraciones disponibles y tiene una breve descripción de lo que hace cada integración. Si la integración tiene más instrucciones de configuración, que se muestra en el catálogo también.

Las integraciones pueden tener una visibilidad restringida: pueden estar restringidas sólo a determinados inquilinos de Provet Cloud o en determinados países. El tercero que proporciona la integración puede elegir la amplitud con la que la integración debe ser visible en los inquilinos. Cuando hay restricciones, la aplicación se muestra en el Catálogo de Integración sólo en aquellos inquilinos / en aquellos países en los que está permitida.

Cada vez que un nuevo cliente se registra para utilizar una integración, es decir, la elige del catálogo de integraciones en Provet Cloud (Añadir aplicación), se envían credenciales de cliente únicas al proveedor de la integración. Hay dos opciones para notificar el registro de un nuevo cliente que se pueden elegir al crear una plantilla de integración:

Cuando la integración se utiliza sólo en una instancia de Provet Cloud, el correo electrónico es una buena opción: entonces la persona que recibe el correo electrónico puede configurar los detalles de autenticación a la integración y empezar a usarlo. Por otro lado, cuando la integración se utiliza ampliamente, se recomienda la URL de conexión y la automatización de la adición de un nuevo cliente.

Hookup URL está a la escucha de cualquier notificación automatizada de nuevos clientes. Cuando un nuevo cliente añade la integración en Provet Cloud, la herramienta de orquestación envía automáticamente un mensaje JSON a esa URL dada. No hay necesidad de ninguna interacción humana, cuando la integración analiza automáticamente el nuevo cliente desde el mensaje JSON y añade sus credenciales a su tabla de clientes.

Esquema JSON de los datos enviados para los nuevos registros de integración:

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

Cuando se añade una nueva aplicación de integración a Provet Cloud, se crean automáticamente un usuario virtual y un grupo de permisos para la integración. El usuario virtual se llama Integración <Nombre de la integración> y se puede encontrar en Configuración > Usuarios utilizando el filtro Virtual. El grupo de permisos tiene el mismo nombre que la integración.

Provet Cloud admite la gestión automatizada de permisos, lo que reduce el esfuerzo manual y garantiza la coherencia. Esta característica se llama 'plantilla de permisos' y se añade en la plantilla de integración. Póngase en contacto con el soporte de Provet Cloud para obtener su plantilla de permisos en su plantilla de integración.

Cuando se modifican las plantillas de permisos, el grupo de permisos asociado en Provet Cloud se actualiza automáticamente para que coincida con la plantilla más reciente. Los permisos añadidos se incluyen, y los permisos eliminados se excluyen para garantizar la sincronización.

Si no se utiliza una plantilla de permisos, tendrá por defecto los mismos permisos que el grupo de permisos Usuarios.

Si una integración requiere permisos diferentes (algunos endpoints están denegados o desea restringir los permisos), los permisos deben ser editados. Compruebe en el esquema Provet Cloud API qué permisos necesita cada endpoint. Vea también Ver y gestionar permisos de usuario.

Integraciones personalizadas

https://developers.provetcloud.com/

Ejemplo de guía de configuración de la integración

Ejemplo de solución de integración