Guia de operação do diretório central

1. Introdução

O Open Insurance, ou Sistema de Seguros Aberto, é a possibilidade de consumidores de produtos e serviços de seguros, previdência complementar aberta e capitalização permitirem o compartilhamento de suas informações entre diferentes sociedades autorizadas/credenciadas pela SUSEP de forma segura, ágil, precisa e conveniente. Para entregar esses benefícios ao consumidor, o Open Insurance operacionaliza e padroniza o compartilhamento de dados e serviços por meio de abertura e integração de sistemas, com privacidade e segurança. Acesse o site oficial da SUSEP

Antes de Começar

Esse guia tem como objetivo demonstrar, de forma prática, a operação do Diretório Central do Open Insurance Brasil. Além disso, ele é complementar a outras documentações disponibilizadas pela governança e não faz parte do escopo quaisquer detalhamentos relacionados à experiência do usuário e desenvolvedor, definições de segurança e especificação de APIs. Todas as funcionalidades estão disponíveis em sandbox e podem ser testadas em: https://web.sandbox.directory.opinbrasil.com.br/ . Procedimentos em produção pendentes serão disponibilizados assim que possível. As ações aqui apresentadas podem ser realizadas tanto por administradores quanto por contatos técnicos primários e secundários. Para ilustrar este guia e tentar deixar as situações de uso mais palpáveis, foram criadas instituições e telas fictícias.

• As instituições e marcas não são reais.

• As telas desenvolvidas, os softwares e sites são meramente ilustrativos, para que seja possível ver um exemplo de como os requisitos e as recomendações podem ser aplicados em situações de uso real.

• Nomenclaturas e imagens ilustrativas estão descritas na língua inglesa, devido sua ampla abrangência e por conter terminologia técnica que, em algumas situações, não dispõe de tradução literal. O ajuste do idioma no Diretório fica a critério do usuário, podendo ser ajustado a qualquer momento.

Tipos de Usuários

Neste exemplo, mostramos as diversas possibilidades suportadas de atribuições de função para um usuário cadastrado no Diretório.

Open	Administrativo	Usuários com poderes de administração no Diretório, podendo realizar todas ações.
Open	Operação	Usuários com permissão em ferramentas específicas no Diretório.
	Plataforma	Usuários para gestão e operação das plataformas do ecossistema, como o Service Desk, Portal, Plataforma de Resolução de Disputas e Plataforma Centralizada (Ressarcimento).

Relação Organização vs. Marcas

Neste exemplo, mostramos as diversas possibilidades suportadas para se realizar cadastros de organizações no Diretório. Assim, uma organização pode ser cadastrada de forma independente ou pertencente a um conglomerado. Já as marcas são uma forma mais amigável, democrática e fácil para identificação das instituições participantes. Uma Marca de um conglomerado pode estar correlacionada a mais de uma Instituição Participante, assim como uma Instituição Participante pode estar correlacionada a mais de uma marca.

Importante: a Marca cadastrada no diretório será a mesma apresentada para escolha do usuário na Jornada de Compartilhamento de Dados e Iniciação de Pagamentos. As Instituições Participantes (ou organizações) também serão apresentadas em tela, apenas em caráter informativo. Para maiores detalhes, consulte o Guia de Experiência do Usuário.

Pontos de atenção no cadastramento de marca/authorisation server

• Uma marca é representada por um Authorisation Server e o mesmo sempre deve ser cadastrado associado a uma organização.

• O vinculo entre uma organização master (mãe) e uma organização que pertence ao conglomerado é realizado via preenchimento do campo Parent Organization Reference ID no cadastro da organização filha, informando o CNPJ da organização mãe (caso seja necessário ajuste, favor entrar em contato via Service Desk em https://servicedesk.opinbrasil.com.br/servicePortal).

• Quando a estrutura for de um conglomerado (uma organização master e uma ou mais organizações relacionadas) é recomendado o cadastro da marca na instituição mãe, caso as filhas venham a utilizar somente a mesma marca e arquitetura de autenticação. Importante ressaltar que, caso não seja cadastrada uma marca exclusiva para o organização filha, a mesma irá herdar a(s) marca(s) da organização mãe.

• Caso uma marca pertença a uma organização filha, o cadastro deve ser exclusivamente realizado na filha.

• Caso a mesma marca pertença a mais de uma organização, deve ser realizado um cadastro de Authorisation Servers para cada uma das organizações. É recomendado que as configurações dos Authorisation Servers sejam iguais, principalmente o campo Customer Friendly Server Name (marca).

• Quando for necessário cadastrar uma marca exclusiva para uma organização filha, ela deixa de herdar a(s) marca(s) da organização mãe. Caso uma filha tenha que estar relacionada a uma marca exclusiva e também a da mãe, é necessário cadastrar a marca da mãe na filha.

Alternativas para atualização da marca

Cadastramento Fase 1 x Fase 2

• Se o cadastramento do Authorisation Server na Fase 1 já foi realizado com uma marca válida para a Fase 2, é necessário cadastrar os recursos de Fase 2 no mesmo Authorisation Server, mantendo o Customer Friendly Server Name (marca) da Fase 1.

• Se o cadastramento do Authorisation Server na Fase 1 não foi realizado com uma marca válida para a Fase 2: é necessário atualizar o Customer Friendly Server Name (marca) para a Fase 2 e cadastrar os recursos de Fase 2 no mesmo.

• Os recursos da Fase 1 devem estar declarados em pelo menos um Authorisation Server do participante válido para a Fase 2.

• Após esse processo, caso a instituição venha a ter Authorisation Servers / marcas oferecendo recursos exclusivos de fase 2, recomenda-se a criação de novos registros sem os recursos de Fase 1.

2. Registrando um usuário no diretório

Para acessar o Diretório de participantes você precisa estar registrado com um usuário válido. Esta seção descreve as etapas necessárias para realizar o registro de um novo usuário.

ETAPA 1: Registrando um usuário no Diretório

Requisitos

1. No navegador, digite a URL de acordo com o ambiente a ser acessado:

   Sandbox: https://web.sandbox.directory.opinbrasil.com.br/

   Produção: https://web.directory.opinbrasil.com.br/

2. Clique no link Register

3. Na tela Register for an account, preencha os campos do formulário.

4. Clique no botão Register

Nota: E-mails sociais não são permitidos. Você deve utilizar um endereço de e-mail válido da instituição. O cadastro pode ser realizado por qualquer colaborador da organização, identificado aqui como um Iniciador de Cadastro, podendo esse ser tanto um contato administrativo quanto técnico da instituição.

ETAPA 2: Verificando os dados informados

Requisitos

1. Nesta etapa, o Diretório irá enviar uma senha de uso único (OTP), que será encaminhada ao endereço de e-mail e número de telefone informado na etapa anterior.

2. No e-mail recebido, selecione, copie e cole o código OTP no campo EMAIL VERIFICATION CODE.

3. Na mensagem SMS recebida no telefone celular, copie o código OTP e informe no campo PHONE NUMBER VERIFICATION CODE.

4. Clique no botão Verify.

Nota: Caso você não tenha recebido o e-mail com o código de confirmação, verifique sua caixa de SPAM e as políticas de bloqueio de mensagens. O envio das mensagens poderá sofrer algum atraso. Contudo, se o problema persistir, clique no botão Resend OTP para reenvio das mensagens.

ETAPA 3: Confirmando o progresso de registro

Requisitos

1. Nesta etapa, faça o download de um aplicativo de autenticação de sua preferência. É possível utilizar o Google Authenticator, Microsoft Authenticator, LastPass Authenticator, 1Password entre outros.

2. Digitalize o QR Code que aparece na página e no aplicativo de autenticação. Copie e cole a senha de uso único (OTP).

3. Clique no botão Sign-In.

ETAPA 4: Confirmação da assinatura eletrônica

Requisitos

1. Nesta etapa, será enviado um e-mail contendo um link para análise e assinatura do Termo de Aceite.

2. Selecione e copie o código de acesso apresentado na janela Upload e-signature confirmation.

3. Na mensagem recebida na caixa de entrada em nome da DocuSign, clique no link ANALISAR DOCUMENTO. Ao clicar, você será redirecionado para o website da DocuSign.

4. No navegador, cole o valor copiado no passo 2 no campo Código de acesso.

5. Clique no botão Validar.

ETAPA 5: Análise e confirmação do Termo de Aceite

Requisitos

1. Nesta etapa, no website da DocuSign, clique no botão Continuar.

2. Role o documento para baixo e, na página seguinte, clique no ícone Rubricar. No final das páginas, clique no ícone Assinar.

3. Clique no botão Concluir.

4. Na janela "Salvar uma cópia do seu documento", você pode se inscrever para obter uma conta DocuSign gratuita e assinar todos os seus documentos eletronicamente. Nesta janela, também é possível clicar no ícone Fazer Download e baixar uma cópia do documento assinado.

5. Clique no botão Submeter. Ao clicar no botão Submeter, você aceita os Termos e Condições e reconhece que seus dados serão utilizados conforme descrito na Política de Privacidade da DocuSign.

6. Na caixa de entrada, você receberá um e-mail enviado pela DocuSign contendo uma cópia do documento Termo de Aceite assinado eletronicamente.

7. Retorne ao Diretório e, na janela Upload esignature confirmation, clique no botão Check status. Se todas as etapas anteriores forem validadas com sucesso, você será automaticamente redirecionado à página inicial do Diretório.

3. Acessando uma Organisation

Esta seção descreve as etapas necessárias para exibir detalhes de uma organização.

ETAPA 1: Exibindo detalhes de uma organização

Requisitos

1. No Diretório, localize e selecione a sua organização.

2. Revise as informações previamente cadastradas.

Nota: Os cadastrados foram realizados de forma antecipada a partir de informações fornecidas junto a SUSEP. É fundamental que as organizações verifiquem as informações cadastradas. Caso exista alguma divergência, entre em contato pelo e-mail secretariado@opinbrasil.com.br .

Cadastramento de Conglomerado

No diretório de participantes há o conceito de conglomerado. Assim, uma organização mãe poderá ser referenciada em um cadastro de uma organização filha atribuindo-se o CNPJ da organização mãe no campo PARENT ORGANISATION REFERENCE ID da organização filha.

Importante: se a sua organização faz parte de um conglomerado, é fundamental referenciar as organizações filhas com a organização mãe.

4. Cadastrando contatos

Após o onboarding da instituição e do representante da mesma, é necessário realizar o cadastro da equipe de contatos de notificação no Diretório Central. Esses contatos são para possíveis comunicações entre os participantes e a estrutura central.

ETAPA 1: Cadastrando um novo contato

Requisitos

1. No Diretório, localize e selecione a sua organização.

2. Selecione o menu Contacts e clique no botão New Contact.

3. Na janela New Contact preencha os campos do formulário. A tabela a seguir apresenta cada um dos campos em mais detalhes.

4. Clique no botão Save.

Nota: Os usuários de notificação não possuem ações dentro do Diretório e nas demais plataformas do perímetro central.

(*) Campo obrigatório

DETALHAMENTO DOS TIPOS DE CONTATO

Nota: É de inteira responsabilidade da instituição manter os contatos sempre atualizados para que a comunicação entre as instituições participantes não seja prejudicada.

5. Cadastrando reivindicações de domínio de autoridade

Esta seção explica as etapas para cadastrar reivindicações de domínio de autoridade.

ETAPA 1: Cadastrando uma nova reivindicação de domínio

Requisitos

1. No Diretório, localize e selecione a sua organização.

2. Selecione o menu Authority Domain Claims e clique no botão New Domain Claim.

3. Na janela New Authority Domain Claim preencha os campos do formulário. A seguir serão apresentados maiores detalhes sobre os campos.

4. Clique no botão Save.

(*) Campo obrigatório

6. Cadastrando reivindicações autoridade

Esta seção explica as etapas para cadastrar reivindicações de autoridade e como adicionar usuários com suas respectivas funções que serão desempenhadas pela organização dentro do Open Insurance.

Nota: As modalidades assumidas pelos participantes no âmbito do Open Insurance são auto declaratórias e podem ser exercidas simultaneamente. Contudo, tais modalidades deverão estar em conformidade com o modelo de negócio do participante e estarão sujeitas à verificação pela fiscalização da SUSEP, especialmente com relação ao cumprimento do princípio da reciprocidade no compartilhamento de dados no Open Insurance Brasil.

ETAPA 1: Cadastrando uma nova reivindicação de função

Requisitos

1. Necessário realizar a seção "Cadastrando reivindicações de domínio de autoridade".

2. No Diretório, localize e selecione a sua organização.

3. Selecione o menu Authority Domain Role Claims e clique no botão New Role Claim.

4. Na janela New Authority Domain Role Claim preencha os campos do formulário. A seguir serão apresentados os campos em mais detalhes.

5. Clique no botão Save.

(*) Campo obrigatório

ETAPA 2: Cadastrando um usuário de domínio de autorização

Requisitos

1. Necessário ter realizado o cadastro de uma nova reivindicação de domínio.

2. No Diretório, localize e selecione a sua organização.

3. Selecione o menu Authority Domain Role Claims. será carregado um submenu na parte superior esquerda. Então, clique no link Authorisation Domain User.

4. Na janela, clique no botão New Authorisation Domain User.

5. Na janela New Authorisation Domain User, preencha os campos do formulário.

6. Clique no botão Save.

(*) Campo obrigatório

Sistemas e funções de um usuário/contato

Notas

• Os perfis para os sistemas Directory, Service Desk e Dispute Resolution são obrigatórios.

• Para obter mais detalhes dos poderes do usuário verifique a tabela "Modelo de Segurança".

• Podem existir quantos contatos primários e secundários a instituição achar necessário.

• Contatos primários podem acessar o Diretório e adicionar contatos secundários. Já os Contatos secundários não conseguem acessar o Diretório e, consequentemente, não conseguem adicionar novos usuários secundários.

• A implementação dos poderes de acesso de contatos primários e secundários dependem e podem variar de plataforma.

7. Cadastrando servidores de autorização (authorisation servers)

Durante a jornada de consentimento do usuário, os receptores exibirão a marca e o servidor de autorização que está sendo solicitado o acesso aos dados do usuário. Esta seção descreve as etapas necessárias para cadastrar as marcas e os servidores de autorização da organização.

ETAPA 1: Criando um novo servidor de autorização

Requisitos

1. No Diretório, localize e selecione a sua organização.

2. Selecione o menu Authorisation Servers. No canto superior esquerdo será carregado um submenu. Para cadastrar um novo Authorisation Server clique no botão New Authorisation Server localizado no lado direito da tela.

3. Na janela New Authorisation Server, preencha os campos do formulário. A seguir serão apresentados cada um dos campos em mais detalhes. Atenção 1: Tendo em vista a ausência de análise de impacto para o ecossistema da retirada de um Authorisation Server, recomenda-se que os(as) responsáveis por consentimentos não sejam retirados do diretório até a expiração/revogação dos consentimentos pelos quais é responsável. Atenção 2: Caso a instituição queira utilizar alguma chave forte, recomendamos utilizar o AuthorisationServerID. Os campos Customer Friendly Server Name e Description são especialmente suscetíveis a atualizações pelas organizações e não devem ser utilizados para esse fim.

(*) Campo obrigatório

Nota: O campo Customer Friendly Logo URI é o que a receptora deverá utilizar para apresentar a logomarca da transmissora.

(*) Campo obrigatório

Detalhamento do Logotipo

O logotipo das instituições participantes deverá ser aplicado no Portal do Cidadão e também poderá ser aplicado no redirecionamento entre instituições durante a Jornada de Compartilhamento de Dados. Por isso foram deliberadas práticas para uso e disponibilização:

• Utilizar preferencialmente logotipo prioritário, que os clientes reconheçam nos canais.

• Versão reduzida do logo, símbolo ou favicon de site.

• Enviar arquivo SVG contendo a área de proteção do logo da instituição para garantir a leitura e o espaçamento correto.

• Formato de envio:

_{SVG
 Dimensão mínima: 512px x 512px
 Sem sombra}

• Peso máximo do arquivo: 1 mega.

ETAPA 2: Cadastrando certificação de segurança no servidor

Requisitos

1. No Diretório, localize e selecione a sua organização.

2. Selecione o menu Authorisation Servers. Depois selecione o servidor de autorização que deseja. Após selecionar, vá no submenu do lado superior esquerdo e clique em Server Certifications.

3. Dentro dessa área, para cadastrar uma nova certificação, clique no botão Add New Certification localizado no lado direito da tela.

4. Na janela New certification preencha os campos do formulário. A seguir serão apresentados os campos em mais detalhes.

As informações da certificação do Authorisation Server são referentes à certificação FAPI obtida através da OpenID Foundation. Dentro do site é possível encontrar uma tabela Open Insurance Brazil (Based on FAPI 1 Advanced Final) que contém as informações que devem ser refletidas no formulário para adição da certificação de segurança.

(*) Campo obrigatório

8. Cadastrando recursos de uma API (endpoints)

Esta seção explica as etapas para cadastrar os endpoints de recursos de uma API.

Cadastramento de Recursos

Para cada uma das famílias de APIs devem ser adicionados todos os endpoints disponíveis. Segue abaixo um exemplo de disponibilização do cadastramento de recursos:

Nota: Na Fase 2 o padrão de cadastramento continua como na Fase 1. Seguem, aqui, alguns pontos de atenção:

• Na API de consentimento é necessário apenas o cadastramento de uma entrada para o GET e o DELETE;

• A API de customers foi dividida em duas famílias para facilitar o consumos pelos receptores. Customers-business onde é cadastrado os Endpoints PJ e customers-personal onde será cadastrado os endpoints PF. Cabendo aqui o cadastramento conforme a disponibilização do produto pela instituição;

Tabela Exemplo Recursos Fase 1

Observação: a tabela acima não é exaustiva, ou seja, não contém todas as APIs da Fase 1 para o Open Insurance Brasil.

Tabela Exemplo Recursos Fase 2

Observação: a tabela acima não é exaustiva, ou seja, não contém todas as APIs da Fase 2 para o Open Insurance Brasil.

ETAPA 1: Cadastrando um novo recurso de uma API

Requisitos

1. No Diretório, localize e selecione a sua organização.

2. Selecione o menu Authorisation Servers e clique no link do servidor de autorização na qual se deseja cadastrar os recursos.

3. No canto superior esquerdo da página clique em API Resources.

4. Na página que será carregada, clique no botão New API Resources para abrir a janela New API Resource.

5. Na janela New API Resource, clique na caixa de seleção API Family Type e selecione uma das opções disponíveis.

6. No campo ao lado, em Version especifique o valor apropriado utilizando versionamento semântico (major.minor.patch, exemplo: 1.0.7)

7. No campo Certification URI é necessário informar a URI onde se encontra a localização do certificado publicado no GitHub. Este preenchimento é obrigatório para famílias de APIs a partir da Fase 2.

8. Clique no botão Save.

   Nota: No ambiente de Sandbox do Diretório, caso não exista uma certificação, é possível incluir um endereço para testes: https://openinsurance-brasil.github.io/teste.zip

9. De volta à tela API Resources, informe URI principal no campo API Discovery Endpoints e, em seguida, pressione a tecla Enter.

10. Para cada uma das famílias de APIs repita os passos 4 a 8.

Nota: Todos os endpoints deverão ser preenchidos, incluindo os respectivos recursos. Para obter mais detalhes sobre o padrão do endpoints e versão consulte o Portal do Desenvolvedor do Open Insurance

9. Cadastrando declarações de software (software statements)

Aqui apresentamos a configuração necessária para criar uma nova declaração de software no Diretório.

ETAPA 1: Criando uma nova declaração de software

Requisitos

Open

Open

1. No Diretório, localize e selecione a sua organização.

2. Selecione o menu Software Statements e clique no botão New Software Statement.

3. Na janela New Software Statement preencha os campos do formulário. A seguir serão apresentados cada um dos campos em mais detalhes.

Nota: O campo Logo URI é o que a transmissora deverá utilizar para apresentar a logomarca da receptora.

(*) Campo obrigatório.

ETAPA 2: Cadastrando certificação de declaração de software

Requisitos

Open

Open

1. No Diretório, localize e selecione a sua organização.

2. Selecione o menu Software Statements. Em seguida, selecione a declaração de software que deseja. Após selecionar, vá no submenu à esquerda em cima e clique em Certifications.

3. Dentro dessa área, para cadastrar uma nova certificação, clique no botão Add New Certification localizado no lado direito da tela.

4. Na janela New certification preencha os campos do formulário. A seguir serão apresentados cada um dos campos em mais detalhes.
   As informações da certificação do Software Statement são referentes a certificação FAPI obtida através da OpenID Foundation . Dentro do site é possível encontrar a tabela Brasil Open Insurance (Based on FAPI Relying Parties) que contém as informações que devem ser refletidas no formulário para adição da certificação de segurança.

(*) Campo obrigatório

10. Criando uma nova reivindicação de autoridade de software

Esta seção explica as etapas para criar uma reivindicação de autoridade de software. Esta etapa será necessária para definir as funções regulatórias que serão inseridas no Software Statement Assertion.

ETAPA 1: Criando reivindicação de autoridade de software

Requisitos

Open

1. Necessário realizar a seção "Cadastrando reivindicações de domínio de autoridade".

2. Necessário realizar a seção "Cadastrando reivindicações de autoridade".

3. Necessário ter criado um Software Statements para sua organização.

4. No Diretório, selecione a sua organização e, no menu lateral, clique em Software Statements.

5. No menu lateral, selecione a opção Authority Claims. Na janela Software Statements Details, role a página para baixo, selecione o menu Authority Claims e clique no botão New Software Authority Claims.

6. Na janela New Software Authority Claims preencha os campos do formulário. Os campos serão apresentados, a seguir, em mais detalhes.

(*) Campo obrigatório

11. Criando certificados de transporte e assinatura em Sandbox

As etapas para criar uma Solicitação de Assinatura de Certificado para certificados de transporte e assinatura que não foram emitidos por uma autoridade de certificação e para uso exclusivo em ambiente de Sandbox do Diretório, podem ser acessadas através dos links:

http://hml-dev-portal.s3-website.us-east-2.amazonaws.com/files/OpenInsurance_Gerando_o_Certificado_BRCAC.pdf

http://hml-dev-portal.s3-website.us-east-2.amazonaws.com/files/OpenInsurance_Gerando_o_Certificado_BRSEAL.pdf

12. Carregando certificados emitidos por autoridade de certificação em Produção

Esta seção explica as etapas para importar certificados que foram emitidos por uma autoridade de certificação e para uso exclusivo em ambiente de Produção do Diretório.

ETAPA 1: Carregando certificado de transporte

Requisitos

1. Necessário ter criado um Software Statements para sua organização.

2. No Diretório, selecione a sua organização e, em seguida, selecione o menu Software Statements.

3. Na tela Software Statement, clique no botão New Certificate.

4. Na janela New Certificate, na caixa de seleção Select Certificate Type, selecione a opção EXTERNAL BRCAC e clique no botão Continue.

5. No passo seguinte, em "Generate CSR", clique no botão Continue.

6. Na opção "Upload CSR/PEM", localize o arquivo.csr e clique no botão Continue.

7. Aguarde o carregamento do arquivo para o Diretório e, em seguida, clique no botão Done.

8. Na tela anterior de certificates, vá até actions e clique na seta de download. Salve o arquivo.pem em uma pasta local.

ETAPA 2: Carregando certificado de assinatura

Requisitos

1. No Diretório, selecione a sua organização e clique em Organisations Certificate no menu lateral.

2. Na janela New Organisations Certificate, na caixa de seleção Select Certificate Type, selecione a opção BRSEAL EXTERNAL e clique no botão Continue.

3. No passo seguinte, em Generate CSR, clique no botão Continue.

4. Na opção Upload CSR/PEM, localize o arquivo.csr e clique no botão Continue.

5. Aguarde o carregamento do arquivo para o Diretório e no passo seguinte clique no botão Done.

6. Na tela anterior em Organisation Certificates, vá até actions e clique na seta de download. Salve o arquivo.pem em uma pasta local.

13. Cadastrando administradores da organização

Esta seção explica as etapas necessárias para realizar o cadastro de um novo administrador da organização.

ETAPA 1: Cadastrando um administrador da organização

Requisitos

1. No Diretório, localize e selecione a sua organização.

2. Selecione o menu Organisation Administrator e clique no botão New Organisation Administrators.

3. Na janela New Organisation Administrator preencha o campo do formulário.

4. Clique no botão Save.

Nota: somente administradores da organização podem cadastrar novos administradores.

14. Obtendo um Software Statements Assertion

Uma Software Statements Assertion (SSA) é um JWT assinado do diretório que contém todas as informações sobre um aplicativo que existe em um determinado momento no diretório. Inclui a localização de todas as chaves públicas vinculadas a esta declaração de software e todos os outros metadados de que um banco precisa para validar a legitimidade do aplicativo.

ETAPA 1: Criando uma nova declaração de software assinada

Requisitos

1. Necessário ter criado um Software Statements para sua organização.

2. No Diretório, localize e selecione a sua organização.

3. Vá até o menu Software Statement, acesse o artefato criado anteriormente clicando no link CLIENT NAME.

4. Na janela Software Statement Details, role a página para baixo e selecione o menu Software Statements Assertion.

5. Clique no botão Copy to Clipboard para copiar o SSA gerado pelo Diretório.

15. Configurando eventos de notificação no Diretório

Aqui apresentamos a configuração de Webhook no Diretório.

ETAPA 1: Inscrever-se em um tópico

Requisitos

1. Em seu navegador, navegue até webhook.site e uma URL única e aleatória será gerada automaticamente. Ela poderá ser utilizada para testar e depurar Webhooks e solicitações HTTP.

2. Selecione a URL e a copie.

ETAPA 2: Solicitando uma subscrição

Requisitos

1. No Diretório, selecione a sua organização e vá até a página "detalhes da organização".

2. Selecione o menu Authorisation Servers e, em actions, clique no ícone de edição.

3. Na página Authorisation Server Information, cole a URL obtida na Etapa 1 no campo Notification Webhook Endpoint.

ETAPA 3: Confirmando uma subscrição

Requisitos

1. De volta ao webhook.site, role para baixo e no campo de texto Raw Context selecione e copie a URL em SubscribeURL para se subscrever no tópico.

2. Em uma nova aba do navegador, cole a URL obtida no passo anterior.

3. Pronto! A partir daqui, toda e qualquer modificação que ocorra no Diretório será notificada através de eventos.

ETAPA 4: Analisando um evento de notificação

Requisitos

1. No Diretório, selecione a sua organização e vá até a página detalhes da organização.

2. Selecione o menu Software Statement e em actions clique no ícone editar.

3. Na janela Software Statement Details vá até o campo description e digite qualquer valor e clique no botão Salvar.

4. Neste momento, o Diretório irá enviar uma notificação push.

5. De volta ao webhook.site, clique no primeiro evento que surge na lista a esquerda da tela.

6. Role a tela para baixo e no campo de texto Raw Context localize o novo valor adicionado no atributo description.

16. Obtendo um token de acesso para as APIs do Diretório

Para acessar as APIs do Diretório do Open Insurance, você precisará de um token de acesso. Esta seção descreve as etapas necessárias para adquirir tokens de acesso.

ETAPA 1: Localizando o identificador do cliente

Requisitos

1. Necessário ter criado um Software Statements para sua organização.

2. No Diretório, localize e selecione a sua organização.

3. Vá até o menu Software Statement, acesse o artefato criado anteriormente clicando no símbolo do lápis.

4. Na janela Software Statement Details localize o campo CLIENT ID, selecione e copie o valor.

ETAPA 2: Localizando a URI de token no Diretório

Requisitos

1. No navegador, acesse a URI de descoberta de conexão OpenID de acordo com o ambiente utilizado:

Sandbox

https://auth.sandbox.directory.opinbrasil.com.br/.well-known/openid-configuration

Produção

https://auth.directory.opinbrasil.com.br/.well-known/openid-configuration

1. Localize o endpoint de token que será utilizado para trocar as credenciais de autenticação para tokens de acesso.

ETAPA 3: Adicionando certificados SSL por domínio

Requisitos

1. Necessário ter criado uma Solicitação de Assinatura de Certificado (CSR).

2. Será utilizado o Postman, com fins ilustrativos, para acessar as APIs do Diretório do Open Insurance Brasil. Assim, no Postman, selecione o menu File e em seguida o menu Settings. Um atalho para acessar esta janela é o comando: Ctrl + Vírgula.

3. Na janela Settings, selecione o menu Certificates e clique no link Add Certificate.

4. Na aba Certificates, no campo Host insira um dos valores descritos a seguir de acordo com o ambiente utilizado:

   Sandbox

   matls-auth.sandbox.directory.opinbrasil.com.br

   e

   matls-api.sandbox.directory.opinbrasil.com.br

   Produção

   Matls-auth.directory.opinbrasil.com.br

   e

   Matls-api.directory.opinbrasil.com.br

5. Em CRT file, clique no botão Select file, e localize o arquivo.pem obtido na seção Criando uma solicitação de Assinatura de Certificado (CSR).

6. No passo seguinte, clique no botão KEY File e localize o arquivo.Key criado no processo de geração de chaves na seção "Criando uma solicitação de Assinatura de Certificado (CSR)".

7. Clique no botão Add.

ETAPA 4: Obtendo um token de acesso

Requisitos

1. Para adicionar uma nova requisição a uma coleção, vá no canto superior esquerdo em Collection, clique em ‘...’ na coleção e escolha Add Request. Você também pode criar uma solicitação clicando no menu File > New, e em seguida Request.

2. No campo Enter request URL, digite o valor obtido da URI de token mencionado na etapa 2.

3. Defina o tipo da operação para POST.

4. Vá para a guia Body e selecione o botão de opção‘x-www-form-urlencoded’.

5. Insira os parâmetros como descritos a seguir:

   client_id =

   grant_type = client_credentials

   scope = directory:software

6. Uma vez que todos os parâmetros e valores estejam preenchidos, clique no botão Send.

7. Selecione e copie o valor retornado no atributo access_token.

17. Listando as organizações cadastradas no Diretório via API

Você precisará de um token de acesso para acessar a API Organisations no Diretório. Esta seção descreve as etapas necessárias para listar e visualizar os detalhes das organizações cadastradas no Diretório.

ETAPA 1: Obtendo detalhes das organizações

Requisitos

1. Necessário ter um token de acesso. Veja mais detalhes em "Obtendo um token de acesso para acessar as APIs do Diretório".

2. Para fins ilustrativos será utilizado o Postman para acessar as APIs do Diretório do Open Insurance Brasil. Assim, para adicionar uma nova requisição a uma coleção, vá no canto superior esquerdo em Collection, clique em ‘...’ na coleção e escolha Add Request. Você também pode criar uma solicitação clicando no menu File > New, e em seguida Request.

3. No campo Enter request URL, insira um dos valores descritos a seguir de acordo com o ambiente utilizado:

   Sandbox

   https://matls-api.sandbox.directory.opinbrasil.com.br/organisations

   Produção

   https://matls-api.directory.opinbrasil.com.br/organisations

4. Defina o tipo da operação para GET.

5. Vá para a guia Authorisation e na caixa de seleção Type selecione a opção Bearer Token.

6. Na coluna ao lado, no campo Token cole o access_token obtido na seção "Obtendo um token de acesso para acessar as APIs do Diretório".

7. Uma vez que todos os valores estejam preenchidos, clique no botão Send. Você verá a resposta de dados JSON do servidor no painel inferior.
   
   

Nota: Para localizar uma organização mãe que pertença a um conglomerado, você poderá percorrer na lista de resposta de dados JSON do servidor, capturando o identificador no atributo ParentOrganisationReference das organizações filhas e localizar o mesmo ID na organização cujo o atributo RegistrationId contenha este mesmo valor.

18. Listando os servidores de autorização de uma organização via API

Aqui apresentamos os passos para listar os servidores de autorização de uma organização.

ETAPA 1: Listando os servidores de autorização

Requisitos

1. Necessário ter um token de acesso. Veja mais detalhes em "Obtendo um Token de Acesso para acessar as APIs do Diretório".

2. Necessário ter realizado os passos da seção "Listando as organizações cadastradas no Diretório via API".

3. Será utilizado o Postman, com fins ilustrativos, para acessar as APIs do Diretório do Open Insurance Brasil. Assim, para adicionar uma nova requisição a uma coleção, vá no canto superior esquerdo em Collection, clique em ‘...’ na coleção e escolha Add Request. Você também pode criar uma solicitação clicando no menu File > New, e em seguida Request.

4. No campo Enter request URL, insira um dos valores descritos a seguir de acordo com o ambiente utilizado:

   Sandbox

   matls-api.sandbox.directory.opinbrasil.com.br/organisations//authorisationservers

   Produção

   matls-api.directory.opinbrasil.com.br/organisations//authorisationservers

5. Defina o tipo da operação para GET.

6. Vá para a guia Authorisation e na caixa de seleção Type selecione a opção Bearer Token.

7. Na coluna ao lado, no campo Token, cole o access_token obtido na seção Obtendo um Token de Acesso para acessar as APIs do Diretório.

8. Uma vez que todos os valores estejam preenchidos, clique no botão Send. Você verá a resposta de dados JSON do servidor no painel inferior.

Nota: Na resposta de dados JSON do servidor o atributo customerFriendlyName contém o valor da marca e o CustomerFriendlyLogoUri o logotipo vinculado à marca.

19. Obtendo um Software Statement via API

Aqui apresentamos os passos para obter um Software Statement (SS) no Diretório via API.

ETAPA 1: Obtendo um SS no Diretório via API

Requisitos

1. Necessário ter um token de acesso. Veja mais detalhes em Obtendo um token de acesso para acessar as APIs do Diretório.

2. Necessário ter realizado os passos da seção "Listando as Organizações Cadastradas no Diretório via API".

3. Para fins ilustrativos será utilizado o Postman para acessar as APIs do Diretório do Open Insurance Brasil. Assim, para adicionar uma nova requisição a uma coleção, vá no canto superior esquerdo em Collection, clique em ‘...’ na coleção e escolha Add Request. Você também pode criar uma solicitação clicando no menu File > New, e em seguida Request.

4. No campo Enter request URL, insira um dos valores descritos a seguir de acordo com o ambiente utilizado:

   Sandbox

   matls-api.sandbox.directory.opinbrasil.com.br/organisations//softwarestatements

   Produção

   matls-api.directory.opinbrasil.com.br/organisations//softwarestatement

5. Defina o tipo da operação para GET.

6. Vá para a guia Authorisation e na caixa de seleção Type selecione a opção Bearer Token.

7. Na coluna ao lado, no campo Token cole o access_token obtido na seção "Obtendo um Token de Acesso para acessar as APIs do Diretório".

8. Uma vez que todos os valores estejam preenchidos, clique no botão Send. Você verá a resposta de dados JSON do servidor no painel inferior.

20. Obtendo um Software Statement Assertion via API

Aqui apresentamos os passos para obter um Software Statement Assertion (SSA) no Diretório via API.

ETAPA 1: Obtendo um SSA do Diretório via API

Requisitos

1. Necessário ter um token de acesso. Veja mais detalhes em "Obtendo um Token de Acesso para acessar as APIs do Diretório".

2. Necessário ter realizado os passos da seção "Listando as organizações cadastradas no Diretório via API".

3. Necessário ter realizado os passos da seção "Obtendo um Software Statement via API".

4. Será utilizado o Postman, com fins ilustrativos, para acessar as APIs do Diretório do Open Insurance Brasil. Assim, para adicionar uma nova requisição a uma coleção, vá no canto superior esquerdo em Collection, clique em ‘...’ na coleção e escolha Add Request. Você também pode criar uma solicitação clicando no menu File > New, e em seguida Request.

5. No campo Enter request URL, insira um dos valores descritos a seguir de acordo com o ambiente utilizado:

   Sandbox

   matls-api.sandbox.directory.opinbrasil.com.br/organisations//softwarestatements//assertion

   Produção

   matls-api.directory.opinbrasil.com.br/organisations//softwarestatements//assertion

6. Defina o tipo da operação para GET.

7. Vá para a guia Authorisation e na caixa de seleção Type selecione a opção Bearer Token.

8. Na coluna ao lado, no campo Token, cole o access_token obtido na seção "Obtendo um Token de Acesso para acessar as APIs do Diretório".

9. Uma vez que todos os valores estejam preenchidos, clique no botão Send. Você verá a resposta de dados JSON do servidor no painel inferior.

21. Como se inscrever nas atualizações de lançamento do Diretório

Constantemente são realizados aprimoramentos e atualizações no Diretório. Estas mudanças são registradas em uma página Web onde reside todo o conteúdo do Release Notes. Esta seção descreve as etapas necessárias de inscrição para o recebimento de notificação do release notes do Diretório quando publicado.

ETAPA 1: Cadastrando o recebimento de release notes.

Requisitos

1. Em seu navegador, navegue até site de monitoramento de disponibilidade do Diretório.

2. Clique em “Subscrever atualizações”.

3. Na tela seguinte, adicione seu e-mail e clique no botão "Subscrever". O Diretório irá enviar uma mensagem de confirmação, que será encaminhada ao endereço de e-mail informado.

4. No e-mail recebido, clique no botão "Sim, subscreve-me".

5. Em uma página da Web será apresentada a mensagem informando que seu e-mail encontra-se, agora, subscrito para atualizações de estado Open Insurance Brasil.

Nota: Caso você não tenha recebido o e-mail de confirmação, verifique sua caixa de SPAM e as políticas de bloqueio de mensagens. O envio das mensagens poderá sofrer algum atraso. Contudo, se o problema persistir, clique no botão "Subscrever Alterações" para reenvio das mensagens.

ETAPA 2: Acessando o Release Notes

Requisitos

1. No navegador, digite a URL de acordo com o ambiente a ser acessado:

Sandbox

Produção

22. Como obter suporte ao Diretório

Aqui apresentamos as formas de contato para suporte ao Diretório Central.

Service Desk

Todas as consultas, problemas ou solicitações de suporte precisam ser roteados por meio do Service Desk.

O Service Desk do Open Insurance Brasil pode ser acessado pelo endereço: https://servicedesk.opinbrasil.com.br/

É possível abrir chamados de Solicitação de Informações, Melhorias, Incidentes de Indisponibilidade e Problemas de Performance.