Cadastro do Serviço no Security Server

Objetivo

Cadastrar o serviço desenvolvido no Security Server para exposição via X-Road/X-Valid.

Pré-requisitos

  • Serviço funcional e acessível.
  • Metadados do serviço (name, ID, version, endpoint).
  • Acesso ao Security Server.

Passos

Escolher o Subsistema para Hospedar o Serviço

Lista de Clientes e Subsistemas

Na lista de clientes e subsistema, você escolhe aquele responsável por hospedar o serviço e clica no ícone das engrenagens para configurar serviços REST.

Adicionar um Novo Serviço REST

APIs REST

Verá a lista de APIs REST já cadastradas e poderá adicionar uma nova no botaão “Adicionar API REST”.

Adicionar API REST

Coloque como URL o caminho base do seu serviço no LINK, por exemplo:
http://[URL DO LINK]:[PORTA DO LINK]/link/operator/ O código do serviço pode ser algo como BENEFICIOS. Este nome é apenas uma forma de indicar ao Security Server qual serviço ele está expondo. A versão pode ser v1. Isso permite ter várias versões do mesmo serviço. Estes valores serão usados para compor o identificador do serviço no X-Road/X-Valid, na variável de cabeçalho UXP-Service.

Adicionar Endpoint ao Serviço

O serviço é adicionado sem estar ativado. Vamos clicar no botão + para adicionar um endpoint.

Adicionar Endpoint a API REST

Basta colocar [VERSAO]/[ID] como Caminho tomando como base o que foi informado no LINK.

Adicionar Acesso ao Serviço

Clicamos no escudo ao lado do endpoint para configurar quem pode acessar o serviço. Na seção de Direitos de Acesso, clicamos em Adicionar Acesso. Informamos o cliente que terá permissão para consumir o serviço.

Adicionar Acesso

O cliente será informado na variável de cabeçalho UXP-Client. Por fim, clicamos em ativar no topo para ativar o serviço.