1. Introdução

A tela de Pontos de Extremidade permite ao usuário cadastrar, alterar ou remover pontos de extremidade, que serão utilizados nas funcionalidades de Notificações - Agendamento de consultas e Integração - WebHook.

2. Permissão de acesso

Para ter acesso a essa funcionalidade, a permissão "Manter ponto de extremidade" deverá ser concedida aos perfis responsáveis por controlar a funcionalidade.

Para conceder tal permissão, leia o artigo: Segurança - Configurar acesso (NOVO).

3. Gerenciar Pontos de Extremidade

3.1 Acesse a tela "Pontos de Extremidade" através do seguinte caminho de acesso: Configurações > Integração > Pontos de Extremidade.

Open

3.2 Nessa tela serão listados todos os pontos de extremidade cadastrados.

Open

4. Cadastrar novo ponto de extremidade

4.1 Para cadastrar um novo ponto de extremidade, clique no botão de “Inclusão“.

4.2 Será aberto um modal com os campos para cadastro do novo ponto de extremidade. Inicialmente pode-se definir o Nome, Tipo de ponto de extremidade e se ele será criado Ativo ou Inativo.

Estão disponíveis para seleção 4 tipos de pontos de extremidade. Estes são: API, SFTP, S3 e Azure Storage.

4.3 Os demais campos disponíveis e necessários para o cadastro do ponto de extremidade serão alterados com base no tipo de ponto de extremidade selecionado. A relação de campos por tipo de ponto de extremidade selecionado é:

No exemplo, o tipo de ponto de extremidade selecionado foi API, então os campos disponíveis serão “Caminho“, “URI“ e “Tipo de Credencial“, sendo os dois últimos obrigatórios.

4.4 Os tipos de credenciais disponíveis também variam com o tipo de ponto de extremidade selecionado. A relação de tipos de credenciais disponíveis por tipo de ponto de extremidade selecionado é:

Como no exemplo o tipo de ponto de extremidade selecionado foi API, estarão disponíveis os tipos de credenciais: “Nenhum“, “Bearer Token“ e “OAuth2“.

4.5 Após selecionado o tipo de credencial, deverão ser preenchidos os campos necessários a esse tipo. A tabela abaixo representa a relação de campos por tipo de credencial:

No exemplo, o tipo de credencial escolhido foi Bearer Token, portanto, o campo obrigatório “Bearer Token“ deverá ser preenchido.

4.6 Após preencher todos os campos obrigatórios, basta clicar no botão “Salvar” e o ponto de extremidade será salvo e, se estiver ativo, ficará disponível para uso.

5. Editar ponto de extremidade

5.1 Para editar um ponto de extremidade cadastrado, dê um duplo clique no mesmo e o modal de edição será aberto.

Note que campos que contenham dados sensíveis, como destacados na seção 4.5 deste artigo, não poderão ter seu conteúdo visualizado no modo de edição, mas podem ser sobrescritos livremente.

5.2 Em seguida, faça as alterações que desejar e finalize clicando em "Salvar".

6. Remover ponto de extremidade

6.1 Para remover um ou mais pontos de extremidade cadastrados, basta selecionar (marcar) os pontos de extremidade desejados e finalizar clicando em "Remover".

6.2 Será aberto um diálogo de confirmação com o número de pontos de extremidade selecionados. Clique no botão “Confirmar“ para confirmar a remoção.

6.3 Uma vez que o ponto de extremidade não esteja em uso por consultas customizadas ou webhooks, clicar em “Confirmar“ no modal de confirmação efetuará sua remoção do sistema.

7. Permissões necessárias às credenciais cadastradas no ponto de extremidade

A seguir serão apresentadas as permissões necessárias às credenciais cadastradas em um ponto de extremidade, por tipo de ponto de extremidade: