Integração de aplicações de terceiros com o Provet Cloud

Exemplo de solução de integração

Webhooks

API REST

Adicionar uma aplicação de integração no Provet Cloud

Opções no registo de um novo cliente

Permissões

Liberação de uma integração

O sistema de gestão de clínicas veterinárias Provet Cloud pode ser integrado com aplicações de terceiros através de ferramentas denominadas REST API e webhooks.

Webhooks estão disponíveis no Provet Cloud para enviar notificações a sistemas de terceiros sobre adições ou alterações nos dados dentro do Provet Cloud. Os webhooks não transferem os dados efetivamente alterados, mas transferem a informação sobre o que foi alterado, notificando simplesmente o sistema de terceiros sobre a alteração. Os dados reais podem então ser obtidos pelo sistema de terceiros, utilizando a API REST de Provet Cloud.

REST API é um método de comunicação para aceder, editar ou adicionar aos dados que residem na Provet Cloud de forma programática por qualquer aplicação de terceiros. A API REST da Provet Cloud permite que a maior parte dos principais dados da Provet Cloud sejam lidos ou manipulados por outros sistemas.

A combinação dos webhooks de Provet Cloud & REST API cria possibilidades únicas para a criação de soluções integradas. Qualquer fornecedor de outros sistemas familiarizado com estas tecnologias pode facilmente integrar-se com os dados que residem no sistema de gestão de clínicas veterinárias Provet Cloud, utilizando estas tecnologias.

Antes de poder começar a utilizar as APIs da Provet Cloud, é necessário ativar o acesso ao ambiente de teste. Contacte o nosso Partner Development Manager para começar.

Criaremos um ambiente de teste ao qual poderá aceder durante o desenvolvimento inicial. Também criaremos um modelo de integração com o tipo de concessão OAuth2 pretendido para que tenha acesso ao seu ambiente de teste. Isto permitir-lhe-á desenvolver e testar o seu código com a nossa API.

Consulte a nossa página de programador para obter a documentação da API, o esquema da API e outras informações valiosas para o ajudar no seu desenvolvimento.

Os webhooks são configurados e activados em Definições > Geral > Integrações > Webhooks. Exemplo: "consultation_id=123".

A Provet Cloud fornece a API REST para permitir o acesso aos dados armazenados na Provet Cloud. A API utiliza a autenticação OAuth 2.0. Os dados são devolvidos no formato JSON.

A API REST do Provet Cloud é navegável, o que deve permitir aos programadores avaliar as possibilidades de transferência de dados.

Uma vez criado o modelo, a integração pode ser vista no catálogo de integrações em Provet Cloud: Configurações > Integrações > Acesso à API aberta > Adicionar aplicação. O catálogo lista as integrações disponíveis e apresenta uma breve descrição do que cada integração faz. Se a integração tiver mais instruções de configuração, estas também são apresentadas no catálogo.

As integrações podem ter uma visibilidade restrita: podem ser limitadas apenas a determinados locatários do Provet Cloud ou em determinados países. O terceiro que fornece a integração pode escolher em que medida a integração deve ser visível nos locatários. Quando existem restrições, a aplicação é apresentada no Catálogo de integração apenas nos locatários/países em que é permitida.

Sempre que um novo cliente se regista para utilizar uma integração, ou seja, escolhe-a no catálogo de integração no Provet Cloud (Adicionar aplicação), são enviadas credenciais de cliente únicas para o fornecedor da integração. Existem duas opções para notificar o registo de um novo cliente que podem ser escolhidas ao criar um modelo de integração:

Quando a integração é utilizada apenas numa instância da Provet Cloud, o e-mail é uma boa escolha: a pessoa que recebe o e-mail pode configurar os detalhes de autenticação para a integração e começar a utilizá-la. Por outro lado, quando a integração é amplamente utilizada, recomenda-se a utilização do URL de ligação e a automatização da adição de um novo cliente.

O URL de ligação está à escuta de quaisquer notificações automáticas de novos clientes. Quando um novo cliente adiciona a integração no Provet Cloud, a ferramenta de orquestração envia automaticamente uma mensagem JSON para esse URL. Não é necessária qualquer interação humana, uma vez que a integração analisa automaticamente o novo cliente a partir da mensagem JSON e adiciona as suas credenciais à sua tabela de clientes.

Esquema JSON para os dados enviados para novos registos de integração:

{
"$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 uma nova aplicação de integração é adicionada ao Provet Cloud, um utilizador virtual e um grupo de permissões são automaticamente criados para a integração. O utilizador virtual chama-se Integração <Nome da integração> e pode ser encontrado em Definições > Utilizadores utilizando o filtro Virtual. O grupo de permissões tem o mesmo nome que a integração.

O Provet Cloud suporta a gestão automatizada de permissões, reduzindo o esforço manual e garantindo a consistência. Esta funcionalidade chama-se "modelo de permissão" e é adicionada ao modelo de integração. Contacte a assistência Provet Cloud para obter o seu modelo de permissão no seu modelo de integração.

Quando os modelos de permissão são modificados, o grupo de permissão associado no Provet Cloud é automaticamente atualizado para corresponder ao modelo mais recente. As permissões adicionadas são incluídas e as permissões removidas são excluídas para garantir a sincronização.

Se um modelo de permissão não for utilizado, tem as mesmas permissões por defeito que o grupo de permissões Users.

Se uma integração exigir permissões diferentes (alguns pontos finais são negados ou pretende restringir as permissões), as permissões devem ser editadas. Verifique no esquema da API do Provet Cloud quais as permissões necessárias para cada ponto final. Ver também Ver e gerir as permissões do utilizador.

Integrações personalizadas

https://developers.provetcloud.com/

Exemplo de guia de configuração de integração

Exemplo de solução de integração