API Directory Integration

Como fazer requisições ao Diretório Central do Open Insurance Brasil com parâmetros específicos.

Visão Geral

Ao fazer uma requisição no Diretório Central sem utilizar parâmetros, será retornado todo o seu conteúdo, isto é, todas as Sociedades Seguradoras.

O Directory Integration é um utilitário para melhor gerenciar as requisições ao Diretório Central.

Ele possui endpoints com funcionalidades adicionais aos do Diretório, como paginação e cache, e é um facilitador nos fluxos das Jornadas e do motor de consentimento.

Pré-requisito

Autenticação: É necessário obter o Access token.

Localização

Este serviço é utilizado nos dois fluxos de Jornadas, Receptora e Transmissora.

Funcionalidades

O Directory Integration oferece buscas por:

  • Marcas registradas;
  • Organizações;
  • API Resources;
  • Marcas por ROLE;

Endpoints

Conheça cada endpoint, as formas de requisição e os exemplos de response body.

GET /v1/authorisationservers

Este endpoint consulta os Authorisaton Servers no Diretório Central.

Exemplo de requisição

       curl -X 'GET' \ '{{baseURL}}/v1/authorisationservers' 
      -H 'accept: */*'

Ao fazer a requisição sem parâmetros, retorna todos os participantes cadastrados no Diretório Central. Para restringir a consulta, use:

  • customerFriendlyName: retorna todas as marcas por similaridade do nome, ou seja, não precisa passar o nome exato. O campo não é case-sensitive;

  • organisationName: retorna todas as organizações por similaridade do nome, ou seja, não precisa passar o nome exato. O campo não é case-sensitive;

  • customerFriendlyDescription: retorna a descrição definida para o campo por similaridade do nome, ou seja, não precisa passar o nome exato. O campo não é case-sensitive;

  • registrationNumber: Se refere ao CNPJ da sociedade consultada. Informe o código completo ou parte dele para retornar um resultado.

  • role: retorna todas as instituições que possuem a role consultada.


Se algum dos parâmetros estiver incorreto ou não existir, a API irá retornar: Status 200 - OK e payload vazio.


GET /v1/authorisationservers/{pageSize}/{page}

Este endpoint consulta os Authorisaton Servers no Diretório Central, permitindo paginação.

( * ) O pageSize e page são path params obrigatórios.

Exemplo de requisição

         curl -X 'GET' \
         '{{baseURL}}/v1/authorisationservers/1/2' \
         -H 'accept: */*'

A resposta de código 200 OK indica que a consulta foi executada com sucesso. Ela retorna um JSON com as Sociedades Seguradoras.


Exemplo de response body - padrão OAuth:

 
{
    "content": [
        {
            "id": "63890f68d3149d310ccc918a",
            "createdDate": "2022-12-01T20:32:40.401+00:00",
            "lastModifiedDate": "2022-12-01T20:32:40.401+00:00",
            "OrganisationId": "4dc94acc-1041-49be-8694-2e02271afe9b",
            "PayloadSigningCertLocationUri": "https://api-btgseguros.openinsurance-dev.btgpactual.com/orgs/btgseguros/jwks",
            "OpenIDDiscoveryDocument": "https://api-btgseguros.openinsurance-dev.btgpactual.com/orgs/btgseguros/.well-known/openid-configuration",
            "CustomerFriendlyName": "BTG Pactual Seguros Auth Server",
            "CustomerFriendlyDescription": "Servidor de Autorizador BTG Pactual Seguros",
            "ApiResources": [
                {
                    "ApiResourceId": "586bd9cc-b8bb-480c-a1a6-261ac3fe628d",
                    "ApiDiscoveryEndpoints": [
                        {
                            "ApiDiscoveryId": "7308a1bf-d8d8-4d90-a390-f5963512a3c7",
                            "ApiEndpoint": "https://api-btgseguros.openinsurance-dev.btgpactual.com/open-insurance/discovery/v1/status"
                        }
                    ],
                    "ApiFamilyType": "discovery_status",
                    "ApiVersion": "1.0.0"
                },
                {
                    "ApiResourceId": "bb51ca1b-f2b9-48cc-9819-de0c7ea8f69a",
                    "ApiDiscoveryEndpoints": [
                        {
                            "ApiDiscoveryId": "bb26b42a-f418-4bd3-8b67-6db37821a267",
                            "ApiEndpoint": "https://mtls-btgseguros.openinsurance-dev.btgpactual.com/open-insurance/customers/v1/business"
                        }
                    ],
                    "ApiFamilyType": "customers-business",
                    "ApiVersion": "1.0.0"
                },
                {
                    "ApiResourceId": "b78dc9ef-916a-4ef7-9b42-ec263113aeb9",
                    "ApiDiscoveryEndpoints": [
                        {
                            "ApiDiscoveryId": "b34f8644-6922-4037-abc5-398836d15123",
                            "ApiEndpoint": "https://mtls-btgseguros.openinsurance-dev.btgpactual.com/open-insurance/customers/v1/personal"
                        }
                    ],
                    "ApiFamilyType": "customers-personal",
                    "ApiVersion": "1.0.0"
                },
                {
                    "ApiResourceId": "f6eac47d-ab29-40e6-8472-dddb70c76bbe",
                    "ApiDiscoveryEndpoints": [
                        {
                            "ApiDiscoveryId": "ad766f7f-6950-483a-beba-d78ef596cb12",
                            "ApiEndpoint": "https://mtls-btgseguros.openinsurance-dev.btgpactual.com/open-insurance/resources/v1"
                        }
                    ],
                    "ApiFamilyType": "resources",
                    "ApiVersion": "1.0.0"
                },
                {
                    "ApiResourceId": "a5047fa5-eb17-4ce6-aee9-73eaa0c08952",
                    "ApiDiscoveryEndpoints": [
                        {
                            "ApiDiscoveryId": "807528a0-5870-495c-b1ab-8241fb4042d9",
                            "ApiEndpoint": "https://mtls-btgseguros.openinsurance-dev.btgpactual.com/open-insurance/consents/v1"
                        }
                    ],
                    "ApiFamilyType": "consents",
                    "ApiVersion": "1.0.0"
                }
            ],
            "AutoRegistrationSupported": true,
            "CustomerFriendlyLogoUri": "https://banking-public-prd.s3.sa-east-1.amazonaws.com/open-finance/logo/btginvestimentos/btginvestimentos.svg",
            "AuthorisationServerId": "7dc6664c-83e7-4f75-85b3-48a9b521504d",
            "Organisation": {
                "createdDate": "2022-12-01T20:32:40.401+00:00",
                "lastModifiedDate": "2022-12-01T20:32:40.401+00:00",
                "OrganisationId": "4dc94acc-1041-49be-8694-2e02271afe9b",
                "Status": "Active",
                "OrganisationName": "BTG PACTUAL SEGUROS S.A.",
                "CreatedOn": "2022-02-18T21:03:25.813Z",
                "LegalEntityName": "BTG PACTUAL SEGUROS S.A.",
                "CountryOfRegistration": "BR",
                "CompanyRegister": "Cadastro Nacional da Pessoa Jurídica",
                "RegistrationNumber": "32724962000180",
                "RegistrationId": "32724962000180",
                "RegisteredName": "BTG PACTUAL SEGUROS S.A.",
                "AddressLine1": "Avenida Brigadeiro Faria Lima, 3477, 14º Andar (Parte), Itaim Bibi",
                "AddressLine2": "SP",
                "City": "SAO PAULO",
                "Postcode": "04538-133",
                "Country": "BR",
                "ParentOrganisationReference": "32724962000180",
                "RequiresParticipantTermsAndConditionsSigning": false,
                "AuthorisationServersCount": 0,
                "AuthorityClaims": [
                    {
                        "Status": "Active",
                        "AuthorisationDomain": "Open Insurance Brasil",
                        "Role": "DADOS",
                        "RegistrationId": "32724962000180-OPIN-DADOS"
                    }
                ]
            }
        }
    ],
    "pageable": {
        "sort": {
            "unsorted": true,
            "sorted": false,
            "empty": true
        },
        "pageNumber": 2,
        "pageSize": 1,
        "offset": 2,
        "paged": true,
        "unpaged": false
    },
    "last": false,
    "totalElements": 62,
    "totalPages": 62,
    "first": false,
    "numberOfElements": 1,
    "sort": {
        "unsorted": true,
        "sorted": false,
        "empty": true
    },
    "number": 2,
    "size": 1,
    "empty": false
}

GET /v1/organisations

Este endpoint lista as Sociedades Seguradoras cadastradas no Diretório Central. Permite filtrar pelo parâmetro Role, retornando todas as sociedades que possuem a role consultada.

Exemplo de requisição

      curl -X 'GET' \ 
           '{{baseURL}}/v1/organisations'
           -H 'accept: */*' \
           -H 'x-transaction-id: ZDQxNzJjOWYtNjVmMC00ZTU0LT'

A resposta de código 200 OK indica que a consulta foi executada com sucesso. Ela retorna um JSON com todas as Sociedades Seguradoras.


Exemplo de response body - padrão OAuth:

 
{
    "content": [
        {
            "authorisationServers": [
                {
                    "OrganisationId": "1f655d72-090b-479c-ab09-4cbf3ec15667",
                    "PayloadSigningCertLocationUri": "https://api.dev.allianztr.hub.b3.fsapps.io/orgs/allianztr/jwks",
                    "ParentAuthorisationServerId": null,
                    "NotificationWebhook": null,
                    "NotificationWebhookStatus": null,
                    "OpenIDDiscoveryDocument": "https://api.dev.allianztr.hub.b3.fsapps.io/orgs/allianztr/.well-known/openid-configuration",
                    "CustomerFriendlyName": "Allianz Trade Auth Server",
                    "CustomerFriendlyDescription": "Servidor de Autorização Allianz Trade",
                    "TermsOfServiceUri": null,
                    "ApiResources": [
                        {
                            "ApiResourceId": "6ee98ae8-1a6f-4eab-82a0-00e865853e9f",
                            "ApiDiscoveryEndpoints": [
                                {
                                    "ApiDiscoveryId": "076f06dc-1613-4f90-bc4f-88709333bf56",
                                    "ApiEndpoint": "https://api.dev.allianztr.hub.b3.fsapps.io/open-insurance/consents/v1"
                                }
                            ],
                            "ApiFamilyType": "consents",
                            "ApiVersion": "1.0.0"
                        },
                        {
                            "ApiResourceId": "df6f7275-17ed-4239-b00b-f51b12d292d2",
                            "ApiDiscoveryEndpoints": [
                                {
                                    "ApiDiscoveryId": "091203f2-d2fe-443a-9ed9-32cfd43afc0c",
                                    "ApiEndpoint": "https://api.dev.allianztr.hub.b3.fsapps.io/open-insurance/customers/v1/business"
                                }
                            ],
                            "ApiFamilyType": "customers-business",
                            "ApiVersion": "1.1.0"
                        },
                        {
                            "ApiResourceId": "66880016-6aa1-415e-a762-53ed91599a60",
                            "ApiDiscoveryEndpoints": [
                                {
                                    "ApiDiscoveryId": "28806b28-f50b-4907-abb5-b0342a60dee4",
                                    "ApiEndpoint": "https://api.dev.allianztr.hub.b3.fsapps.io/open-insurance/resources/v1"
                                }
                            ],
                            "ApiFamilyType": "resources",
                            "ApiVersion": "1.0.0"
                        }
                    ],
                    "AutoRegistrationSupported": false,
                    "CustomerFriendlyLogoUri": "https://finansystech-pub.s3.sa-east-1.amazonaws.com/f_logo.svg",
                    "DeveloperPortalUri": null,
                    "AuthorisationServerId": "2b1d1b59-6a77-403e-aa09-b559e42c70f4"
                }
            ],

GET/v1/organisations/{organisationId}

Este endpoint retorna detalhes da Sociedade consultada quando é informado um organisationID válido.

( * ) O organisationId é um path param obrigatório.

Exemplo de requisição

       curl -X 'GET' \ 
          '{{baseURL}}/v1/organisations'/260e6fb4-e2e3-47b1-b20c-a45753ddf4a5' \
           -H 'accept: */*' \
           -H 'x-transaction-id: ZDQxNzJjOWYtNjVmMC00ZTU0LT'

A resposta de código 200 OKindica que a consulta foi executada com sucesso. Ela retorna um JSON com detalhes da Sociedade Seguradora correspondente ao organisationID informado.


Exemplo de response body - padrão OAuth:

 
{
    "OrgDetails": {
        "OrganisationId": "260e6fb4-e2e3-47b1-b20c-a45753ddf4a5",
        "Status": "Active",
        "OrganisationName": "SEG-MODELO COMPANHIA DE SEGUROS",
        "CreatedOn": "2022-02-18T21:03:44.367Z",
        "LegalEntityName": "SEG-MODELO COMPANHIA DE SEGUROS",
        "CountryOfRegistration": "BR",
        "CompanyRegister": "Cadastro Nacional da Pessoa Jurídica",
        "RegistrationNumber": "96348677000194",
        "RegistrationId": "96348677000194",
        "RegisteredName": "SEG-MODELO COMPANHIA DE SEGUROS",
        "AddressLine1": "Avenida Antonio  Roberto Marinho, Nº 85, 21º Andar (Parte), Brooklin Novo",
        "AddressLine2": "SP",
        "City": "SAO PAULO",
        "Postcode": "04576-010",
        "Country": "BR",
        "ParentOrganisationReference": "",
        "RequiresParticipantTermsAndConditionsSigning": false,
        "AuthorityClaims": [
            {
                "Status": "Active",
                "AuthorisationDomain": "Open Insurance Brasil",
                "Role": "DADOS",
                "RegistrationId": "96348677000194-OPIN-DADOS"
            }
        ]
    }
}

GET/v1/organisations/{organisationId}/authorisationservers

Este endpoint retorna os Authorisation Servers a partir do Id da organização.

( * ) O organisationId é um path param obrigatório.

Exemplo de requisição

       curl -X 'GET' \
           '{{baseURL}}/v1/organisations/260e6fb4-e2e3-47b1-b20c-a45753ddf4a5/authorisationservers' \
         -H 'accept: */*' \
         -H 'x-transaction-id: ZDQxNzJjOWYtNjVmMC00ZTU0LT'

A resposta de código 200 OK indica que a consulta foi executada com sucesso. Ela retorna um JSON com a lista de Authorisation Servers da Sociedade Seguradora correspondente ao organisationId informado.


Exemplo de response body - padrão OAuth:

 
[
    {
        "OrganisationId": "260e6fb4-e2e3-47b1-b20c-a45753ddf4a5",
        "PayloadSigningCertLocationUri": "https://auth-testing-opin.sensedia.com/open-insurance/openid-provider/v1/jwks",
        "ParentAuthorisationServerId": null,
        "NotificationWebhook": null,
        "NotificationWebhookStatus": null,
        "OpenIDDiscoveryDocument": "https://auth-testing-opin.sensedia.com/open-insurance/openid-provider/v1/.well-known/openid-configuration",
        "CustomerFriendlyName": "SENSEDIA - Product Addon (DEV)",
        "CustomerFriendlyDescription": "SENSEDIA - DEV (Product Addon Team)",
        "TermsOfServiceUri": "https://api-portal.segmodelo.com.br",
        "ApiResources": [
            {
                "ApiResourceId": "2e78aba0-6287-4c7d-84ca-3f363ab7bacf",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "f5cce417-4de0-4183-8134-e381fa354daa",
                        "ApiEndpoint": "https://matls-auth-testing-opin.sensedia.com/open-insurance/resources/v1"
                    }
                ],
                "ApiFamilyType": "resources",
                "ApiVersion": "1.0.0"
            },
            {
                "ApiResourceId": "8ad41ce6-7be2-4073-a7da-85a2a963ab61",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "535fc899-e3f2-4b9a-98c4-d9dd7c0441b2",
                        "ApiEndpoint": "https://matls-auth-testing-opin.sensedia.com/open-insurance/consents/v1"
                    }
                ],
                "ApiFamilyType": "consents",
                "ApiVersion": "1.0.0"
            },
            {
                "ApiResourceId": "ebd6de9b-b57f-4db1-9099-358e5745fedf",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "f0ef3327-0eed-4a3e-a1c0-ce750d674af8",
                        "ApiEndpoint": "https://matls-auth-testing-opin.sensedia.com/open-insurance/customers/v1/personal"
                    }
                ],
                "ApiFamilyType": "customers-personal",
                "ApiVersion": "1.0.0"
            },
            {
                "ApiResourceId": "cd86e991-186c-437c-bd8f-ad0f1e874f35",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "e8994fbf-be8e-4fc6-812b-92f9148a4bf2",
                        "ApiEndpoint": "https://matls-auth-testing-opin.sensedia.com/open-insurance/insurance-patrimonial/v1"
                    }
                ],
                "ApiFamilyType": "patrimonial",
                "ApiVersion": "1.0.0"
            },
            {
                "ApiResourceId": "f1dff246-bb03-407f-b547-9fe23d543963",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "3593878b-7cbb-4773-b307-76eb8f9a8c2d",
                        "ApiEndpoint": "https://matls-auth-testing-opin.sensedia.com/open-insurance/customers/v1/business"
                    }
                ],
                "ApiFamilyType": "customers-business",
                "ApiVersion": "1.0.0"
            }
        ],
        "AutoRegistrationSupported": true,
        "CustomerFriendlyLogoUri": "https://upload.wikimedia.org/wikipedia/commons/b/b9/Slack_Technologies_Logo.svg",
        "DeveloperPortalUri": "https://api-portal.segmodelo.com.br",
        "AuthorisationServerId": "a474bf61-0f19-4bea-b095-25e49cee9310"
    },

GET/v1/organisations/{organisationId}/authorisationservers/{authorisationServerId}

Este endpoint retorna uma marca/Authorisation Server a partir do Id da organização.

( * ) O organisationId e authorisationServerId são path params obrigatórios.

Exemplo de requisição

         curl -X 'GET' \
            '{{baseURL}}/v1/organisations/260e6fb4-e2e3-47b1-b20c-a45753ddf4a5/authorisationservers/b5e17adb-e80c-48d3-a4cb-cc18b4356dc2' \
           -H 'accept: */*' \
           -H 'x-transaction-id: ZDQxNzJjOWYtNjVmMC00ZTU0LT'

A resposta de código 200 OK indica que a consulta foi executada com sucesso. Ela retorna um JSON com o Authorisation Server associado à Sociedade, correspondente ao organisationId e ao Authorisation Server informados.


Exemplo de response body - padrão OAuth:

 
{
    "OrganisationId": "260e6fb4-e2e3-47b1-b20c-a45753ddf4a5",
    "OrganisationName": "SEG-MODELO COMPANHIA DE SEGUROS",
    "RegistrationNumber": "96348677000194",
    "PayloadSigningCertLocationUri": "https://opin.qa.segmodelo.com.br/jans-auth/jwks",
    "ParentAuthorisationServerId": null,
    "NotificationWebhook": null,
    "NotificationWebhookStatus": null,
    "OpenIDDiscoveryDocument": "https://opin.qa.segmodelo.com.br/jans-auth/.well-known/openid-configuration",
    "CustomerFriendlyName": "Ambiente SandBox Seg-Modelo Open Insurance",
    "CustomerFriendlyDescription": "Ambiente SandBox Seg-Modelo Open Insurance",
    "TermsOfServiceUri": "https://api-portal.segmodelo.com.br",
    "ApiResources": [
        {
            "ApiResourceId": "844481b5-10a4-4236-bd0a-0860b07bd814",
            "ApiDiscoveryEndpoints": [
                {
                    "ApiDiscoveryId": "4ad3f30e-c7c9-444a-8fd0-c4a3a0374e8c",
                    "ApiEndpoint": "https://opin.qa.segmodelo.com.br/open-insurance/discovery/v1/status"
                }
            ],
            "ApiFamilyType": "discovery_status",
            "ApiVersion": "1.1.0"
        },
        {
            "ApiResourceId": "da610ef7-e9f6-42bd-b414-59b045d92a1b",
            "ApiDiscoveryEndpoints": [
                {
                    "ApiDiscoveryId": "6bacf800-3f21-4a79-b329-66b5905c2f90",
                    "ApiEndpoint": "https://opin.mtls-qa.segmodelo.com.br/open-insurance/resources/v1"
                }
            ],
            "ApiFamilyType": "resources",
            "ApiVersion": "1.0.0"
        },
        {
            "ApiResourceId": "0a457e4e-415f-401e-a105-830b9cd9a311",
            "ApiDiscoveryEndpoints": [
                {
                    "ApiDiscoveryId": "be9b1413-a149-4b62-83d0-4a1f859b4163",
                    "ApiEndpoint": "https://opin.qa.segmodelo.com.br/open-insurance/admin/v1/metrics"
                }
            ],
            "ApiFamilyType": "admin",
            "ApiVersion": "1.1.0"
        },
        {
            "ApiResourceId": "e50554b0-5022-4666-a99f-53a2b0e249c8",
            "ApiDiscoveryEndpoints": [
                {
                    "ApiDiscoveryId": "ac404eb8-8144-423b-b3f6-5083b2eb1f18",
                    "ApiEndpoint": "https://opin.mtls-qa.segmodelo.com.br/open-insurance/customers/v1/personal"
                }
            ],
            "ApiFamilyType": "customers-personal",
            "ApiVersion": "1.0.0"
        },
        {
            "ApiResourceId": "2f726d15-d6d8-421e-8943-22505ae9fd8f",
            "ApiDiscoveryEndpoints": [
                {
                    "ApiDiscoveryId": "83236139-a0bd-4f11-9dce-45445f836282",
                    "ApiEndpoint": "https://opin.mtls-qa.segmodelo.com.br/open-insurance/insurance-patrimonial/v1"
                }
            ],
            "ApiFamilyType": "patrimonial",
            "ApiVersion": "1.0.0"
        },
        {
            "ApiResourceId": "593076dc-9421-474c-bcfa-d30ff3aeba30",
            "ApiDiscoveryEndpoints": [
                {
                    "ApiDiscoveryId": "eaf83079-8136-43b8-b046-19c472a2df33",
                    "ApiEndpoint": "https://opin.mtls-qa.segmodelo.com.br/open-insurance/consents/v1"
                }
            ],
            "ApiFamilyType": "consents",
            "ApiVersion": "1.0.0"
        },
        {
            "ApiResourceId": "ae69f73f-d681-45ec-bb83-fa78b3680d63",
            "ApiDiscoveryEndpoints": [
                {
                    "ApiDiscoveryId": "9de1fbe1-b4e8-464f-b946-4a38cf0cb119",
                    "ApiEndpoint": "https://opin.mtls-qa.segmodelo.com.br/open-insurance/customers/v1/business"
                }
            ],
            "ApiFamilyType": "customers-business",
            "ApiVersion": "1.0.0"
        }
    ],
    "AutoRegistrationSupported": true,
    "CustomerFriendlyLogoUri": "https://www.instituicao.com.br/naoseaplica.svg",
    "DeveloperPortalUri": "https://api-portal.segmodelo.com.br",
    "AuthorisationServerId": "b5e17adb-e80c-48d3-a4cb-cc18b4356dc2"
}

GET/v1/organisations/{organisationId}/authorisationservers/{authorisationServerId}/apiresources

Este endpoint traz uma lista de API resources de um Authorisation Server a partir do Id da organização.

( * ) O organisationId e authorisationServerId são path params obrigatórios.

Exemplo de requisição

       curl -X 'GET' \
          '{{baseURL}}/v1/organisations/260e6fb4-e2e3-47b1-b20c-a45753ddf4a5/authorisationservers/b5e17adb-e80c-48d3-a4cb-cc18b4356dc2/apiresources' \
         -H 'accept: */*' \
         -H 'x-transaction-id: ZDQxNzJjOWYtNjVmMC00ZTU0LT'

A resposta de código 200 OK indica que a consulta foi executada com sucesso. Ela retorna um JSON com os API Resources associados à Sociedade e ao Authorisation Server informados.


Exemplo de response body - padrão OAuth:

 
[
    {
        "ApiResourceId": "844481b5-10a4-4236-bd0a-0860b07bd814",
        "ApiDiscoveryEndpoints": [
            {
                "ApiDiscoveryId": "4ad3f30e-c7c9-444a-8fd0-c4a3a0374e8c",
                "ApiEndpoint": "https://api-sandbox.segmodelo.com.br/open-insurance/discovery/v1/status"
            }
        ],
        "ApiFamilyType": "discovery_status",
        "ApiVersion": "1"
    },
    {
        "ApiResourceId": "5427ae57-7270-4d8a-9882-4b3766cecc42",
        "ApiDiscoveryEndpoints": [
            {
                "ApiDiscoveryId": "e53540fb-f706-468a-8cbc-69cf87ebd753",
                "ApiEndpoint": "https://api-sandbox.segmodelo.com.br/open-insurance/admin/v1/metrics"
            }
        ],
        "ApiFamilyType": "admin",
        "ApiVersion": "1"
    },
    {
        "ApiResourceId": "2f726d15-d6d8-421e-8943-22505ae9fd8f",
        "ApiDiscoveryEndpoints": [
            {
                "ApiDiscoveryId": "83236139-a0bd-4f11-9dce-45445f836282",
                "ApiEndpoint": "https://opin.mtls-qa.segmodelo.com.br/open-insurance/insurance-patrimonial/v1"
            }
        ],
        "ApiFamilyType": "patrimonial",
        "ApiVersion": "1.0.0"
    },
    {
        "ApiResourceId": "593076dc-9421-474c-bcfa-d30ff3aeba30",
        "ApiDiscoveryEndpoints": [
            {
                "ApiDiscoveryId": "eaf83079-8136-43b8-b046-19c472a2df33",
                "ApiEndpoint": "https://opin.mtls-qa.segmodelo.com.br/open-insurance/consents/v1"
            }
        ],
        "ApiFamilyType": "consents",
        "ApiVersion": "1.0.0"
    },
    {
        "ApiResourceId": "da610ef7-e9f6-42bd-b414-59b045d92a1b",
        "ApiDiscoveryEndpoints": [
            {
                "ApiDiscoveryId": "6bacf800-3f21-4a79-b329-66b5905c2f90",
                "ApiEndpoint": "https://opin.mtls-qa.segmodelo.com.br/open-insurance/resources/v1"
            }
        ],
        "ApiFamilyType": "resources",
        "ApiVersion": "1.0.0"
    },
    {
        "ApiResourceId": "e50554b0-5022-4666-a99f-53a2b0e249c8",
        "ApiDiscoveryEndpoints": [
            {
                "ApiDiscoveryId": "ac404eb8-8144-423b-b3f6-5083b2eb1f18",
                "ApiEndpoint": "https://opin.mtls-qa.segmodelo.com.br/open-insurance/customers/v1/personal"
            }
        ],
        "ApiFamilyType": "customers-personal",
        "ApiVersion": "1.0.0"
    },
    {
        "ApiResourceId": "ae69f73f-d681-45ec-bb83-fa78b3680d63",
        "ApiDiscoveryEndpoints": [
            {
                "ApiDiscoveryId": "9de1fbe1-b4e8-464f-b946-4a38cf0cb119",
                "ApiEndpoint": "https://opin.mtls-qa.segmodelo.com.br/open-insurance/customers/v1/business"
            }
        ],
        "ApiFamilyType": "customers-business",
        "ApiVersion": "1.0.0"
    }
]

GET/v1/organisations/{organisationId}/authorisationservers/{authorisationServerId}/apiresources/{apiResourceId}

Este endpoint busca o API Resource de um Authorisation Server a partir do Id da organização.

( * ) O organisationId, authorisationServerIde e apiResourceId são path params obrigatórios.

Exemplo de requisição

       curl -X 'GET' \
         '{{baseURL}}/v1/organisations/60e6fb4-e2e3-47b1-b20c-a45753ddf4a5/authorisationservers/b5e17adb-e80c-48d3-a4cb-cc18b4356dc2/apiresources/da610ef7-e9f6-42bd-b414-59b045d92a1b' \
        -H 'accept: */*' \
        -H 'x-transaction-id: ZDQxNzJjOWYtNjVmMC00ZTU0LT'

A resposta de código 200 OK indica que a consulta foi executada com sucesso. Ela retorna um JSON com o API Resource associados à Sociedade correspondente ao organisationId e Authorisation Server informados.


Exemplo de response body - padrão OAuth:

 
{
    "ApiResourceId": "da610ef7-e9f6-42bd-b414-59b045d92a1b",
    "ApiDiscoveryEndpoints": [
        {
            "ApiDiscoveryId": "6bacf800-3f21-4a79-b329-66b5905c2f90",
            "ApiEndpoint": "https://opin.mtls-qa.segmodelo.com.br/open-insurance/resources/v1"
        }
    ],
    "ApiFamilyType": "resources",
    "ApiVersion": "1.0.0"
}

Evidência dos Testes

GET/v1/authorisationservers

Esse endpoint é dinamicamente atualizado, dependendo do ambiente. Realizamos um teste para que o endpoint liste as marcas associadas a um CNPJ.

URL do diretório: https://data.sandbox.directory.opinbrasil.com.br/participants

Cenários de teste

Se aplicação cliente passar um CNPJ válido no parâmetro registrationNumber ao realizar operação de GET na api do Opin-clients

Então retornar no payload somente as marcas relacionadas ao CNPJ consultado

E as marcas associadas registrationNumber

Se não Retornar Status Code 200

E array vazio

:thumbsup:Jornada positiva

Teste 1 - CNPJ consultado: 87376109000106

 
[
    {
        "OrganisationId": "e31d7750-51e9-4e68-8d9d-dd2fa4b532a4",
        "PayloadSigningCertLocationUri": "https://zu-api.zsbrasil.com/open-insurance",
        "ParentAuthorisationServerId": null,
        "NotificationWebhook": null,
        "NotificationWebhookStatus": null,
        "OpenIDDiscoveryDocument": "https://zu-api.zsbrasil.com/open-insurance/naoseaplica",
        "CustomerFriendlyName": "Seg Modelo",
        "CustomerFriendlyDescription": "A Seg-Modelo é uma joint venture entre os Grupos Seguradora e Modelo com atuação no Brasil, México, Chile, Argentina, Uruguai e sede em Madri.",
        "TermsOfServiceUri": null,
        "ApiResources": [
            {
                "ApiResourceId": "77f70b8a-d1dc-4f7c-8607-ab4df60267b9",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "55ac8191-2e3c-4e95-a9f7-17b60d90412f",
                        "ApiEndpoint": "https://mtls-auth-sandbox.zsopin.com.br/open-insurance/customers/v1/personal"
                    }
                ],
                "ApiFamilyType": "customers-personal",
                "ApiVersion": "1.0.0"
            },
            {
                "ApiResourceId": "efe63c67-daba-47e0-ad17-4bc3aecf2471",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "7a07fcfb-7655-4a1f-a4d6-e40a97c7ae8f",
                        "ApiEndpoint": "https://mtls-auth-sandbox.zsopin.com.br/open-insurance/resources/v1"
                    }
                ],
                "ApiFamilyType": "resources",
                "ApiVersion": "1.0.0"
            },
            {
                "ApiResourceId": "2d26b769-36e3-4c6a-9ab8-7c6a7cb5447f",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "fbff0461-68ae-4512-b210-3f774ef35acd",
                        "ApiEndpoint": "https://mtls-auth-sandbox.zsopin.com.br/open-insurance/customers/v1/business"
                    }
                ],
                "ApiFamilyType": "customers-business",
                "ApiVersion": "1.0.0"
            },
            {
                "ApiResourceId": "2d74d7aa-7e06-461c-8a17-945b1d616b01",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "7ca284c8-bac3-4653-8c6e-5626cb170b43",
                        "ApiEndpoint": "https://mtls-auth-sandbox.zsopin.com.br/open-insurance/insurance-patrimonial/v1"
                    }
                ],
                "ApiFamilyType": "patrimonial",
                "ApiVersion": "1.0.0"
            },
            {
                "ApiResourceId": "60fcb016-2ed6-4520-9b00-ab1b9ed7c7ac",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "9277c0de-57cc-46bf-905f-a445bad7c3e3",
                        "ApiEndpoint": "https://mtls-auth-sandbox.zsopin.com.br/open-insurance/consents/v1"
                    }
                ],
                "ApiFamilyType": "consents",
                "ApiVersion": "1.0.0"
            }
        ],
        "AutoRegistrationSupported": true,
        "CustomerFriendlyLogoUri": "https://zs-images.zsbrasil.com/opin/logo_seg-modelo_santander_horizontal.svg",
        "DeveloperPortalUri": null,
        "AuthorisationServerId": "0fefaf5b-cd91-4e03-85e2-8755e852d2e8",
        "Organisation": {
            "OrganisationId": "e31d7750-51e9-4e68-8d9d-dd2fa4b532a4",
            "Status": "Active",
            "OrganisationName": "SEG-MODELO SEGUROS E PREVIDENCIA S.A.",
            "CreatedOn": "2022-02-18T21:06:28.689Z",
            "LegalEntityName": "SEG-MODELO SEGUROS E PREVIDENCIA S.A.",
            "CountryOfRegistration": "BR",
            "CompanyRegister": "Cadastro Nacional da Pessoa Jurídica",
            "RegistrationNumber": "87376109000106",
            "RegistrationId": "87376109000106",
            "RegisteredName": "SEG-MODELO SEGUROS E PREVIDENCIA S.A.",
            "AddressLine1": "Avenida Jornalista Roberto Marinho, Nº 85, 23ª Andar, Sala 04, Cidade Monções",
            "AddressLine2": "SP",
            "City": "SAO PAULO",
            "Postcode": "04576-010",
            "Country": "BR",
            "ParentOrganisationReference": "87376109000106",
            "RequiresParticipantTermsAndConditionsSigning": false,
            "AuthorityClaims": [
                {
                    "Status": "Active",
                    "AuthorisationDomain": "Open Insurance Brasil",
                    "Role": "DADOS",
                    "RegistrationId": "87376109000106-OPIN-DADOS"
                }
            ]
        }
    }
]



Teste 2 - CNPJ consultado: 00000010742851

 
[
    {
        "OrganisationId": "fe638203-153c-4915-b80a-2ca470a3b25c",
        "PayloadSigningCertLocationUri": "https://www.example.com",
        "ParentAuthorisationServerId": null,
        "NotificationWebhook": null,
        "NotificationWebhookStatus": null,
        "OpenIDDiscoveryDocument": "https://auth.mockbank.poc.raidiam.io/.well-known/openid-configuration",
        "CustomerFriendlyName": "TesteServidorAuth",
        "CustomerFriendlyDescription": "12",
        "TermsOfServiceUri": null,
        "ApiResources": [],
        "AutoRegistrationSupported": true,
        "CustomerFriendlyLogoUri": "https://www.example.com/file.svg",
        "DeveloperPortalUri": null,
        "AuthorisationServerId": "7f3c00a2-9d1a-4a69-846a-4b33c1fee374",
        "Organisation": {
            "OrganisationId": "fe638203-153c-4915-b80a-2ca470a3b25c",
            "Status": "Active",
            "OrganisationName": "OPEN INSURANCE BRASIL - RAIDIAM",
            "CreatedOn": "2022-02-18T20:53:08.136Z",
            "LegalEntityName": "Raidiam Services Ltd",
            "CountryOfRegistration": "UK",
            "CompanyRegister": "VAT Number",
            "RegistrationNumber": "00000010742851",
            "RegisteredName": "Raidiam Services Ltd",
            "AddressLine1": "199 Bishopsgate",
            "AddressLine2": "Vila",
            "City": "London",
            "Postcode": "EC2M 3TY",
            "Country": "UK",
            "ParentOrganisationReference": "",
            "RequiresParticipantTermsAndConditionsSigning": false,
            "AuthorityClaims": [
                {
                    "Status": "Active",
                    "AuthorisationDomain": "Raidiam",
                    "Role": "Dev",
                    "RegistrationId": "21345678"
                }
            ]
        }
    },
    {
        "OrganisationId": "fe638203-153c-4915-b80a-2ca470a3b25c",
        "PayloadSigningCertLocationUri": "https://www.unused.com",
        "ParentAuthorisationServerId": null,
        "NotificationWebhook": null,
        "NotificationWebhookStatus": null,
        "OpenIDDiscoveryDocument": "https://www.unused.com/.well-known/openid-configuration",
        "CustomerFriendlyName": "Raidiam",
        "CustomerFriendlyDescription": "Raidiam auth server",
        "TermsOfServiceUri": null,
        "ApiResources": [
            {
                "ApiResourceId": "57464b81-e576-4852-a239-65b71f927472",
                "ApiDiscoveryEndpoints": [],
                "ApiFamilyType": "consents",
                "ApiVersion": "3.0.0"
            },
            {
                "ApiResourceId": "f9fe4bf6-2b34-4449-b1fe-13b62010b8c4",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "ed97304e-94a9-4ea3-b8c1-1b1cc6bf770f",
                        "ApiEndpoint": "https://openapi-uat.tooseguros.com.br/open-insurance/products-services/v1/housing"
                    }
                ],
                "ApiFamilyType": "products-services_housing",
                "ApiVersion": "1.0.0"
            },
            {
                "ApiResourceId": "79104d5d-e203-4c5f-8a35-44e8a26aca76",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "c26ad38a-a608-4d8b-875a-482278759015",
                        "ApiEndpoint": "https://btgseguros.openinsurance.btgpactual.com/open-insurance/products-services/v1/public-guarantee"
                    }
                ],
                "ApiFamilyType": "products-services_public-guarantee",
                "ApiVersion": "5.0.0"
            },
            {
                "ApiResourceId": "5ac62104-7e3a-41ea-a50c-3ed32cbe5f3d",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "268b6fed-1420-4433-bd9a-be48065298d6",
                        "ApiEndpoint": "https://eu-brazil.apis.allianz.com/open-insurance/products-services/v1/auto-insurance/22743520/018073/2011"
                    }
                ],
                "ApiFamilyType": "products-services_auto-insurance",
                "ApiVersion": "1"
            },
            {
                "ApiResourceId": "c7ec3ca2-ff9c-4c61-a218-0c91abd2a6ac",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "b883375c-e03e-44ff-8dea-e5fdb7c6b4ce",
                        "ApiEndpoint": "https://brportal.chubb.com/opin/api/open-insurance/products-services/v1/person"
                    }
                ],
                "ApiFamilyType": "products-services_person",
                "ApiVersion": "4.0.0"
            },
            {
                "ApiResourceId": "af848378-1e9f-4a3a-ab59-c017a8745b0f",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "a5370848-666d-4980-a5a9-d79e699a5ae6",
                        "ApiEndpoint": "https://opin.santanderauto.com.br/hdibrstd/open-insurance/products-services/v1/auto-insurance/05533-000/004519-5/2020"
                    }
                ],
                "ApiFamilyType": "products-services_auto-insurance",
                "ApiVersion": "1.2"
            },
            {
                "ApiResourceId": "ba62a4f6-fc8a-4bbc-a1ad-89aeca296b05",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "c5cc8294-f62d-4863-9d9d-7a9babb1ce5f",
                        "ApiEndpoint": "https://api.cnpbrasil.com.br/cnpbrasil/prd/open-insurance/products-services/v1/auto-insurance/32/51306/2001"
                    }
                ],
                "ApiFamilyType": "products-services_auto-insurance",
                "ApiVersion": "1.1.0"
            },
            {
                "ApiResourceId": "006a1ae9-7806-444a-bf29-a2c72da30a4f",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "cd0c53d0-21f8-46fd-841c-190f4bb0bb46",
                        "ApiEndpoint": "https://btgseguros.openinsurance.btgpactual.com/open-insurance/products-services/v1/public-guarantee"
                    }
                ],
                "ApiFamilyType": "products-services_public-guarantee",
                "ApiVersion": "1"
            },
            {
                "ApiResourceId": "2e036e1d-2952-45af-9022-135191caa073",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "d66b9c47-e695-4fbd-bdf1-f576fe1bbdc6",
                        "ApiEndpoint": "https://eu-brazil.apis.allianz.com/open-insurance/products-services/v1/auto-insurance/22743520/018073/2011"
                    }
                ],
                "ApiFamilyType": "products-services_auto-insurance",
                "ApiVersion": "1.2"
            },
            {
                "ApiResourceId": "e00d7f1c-a68e-4457-b4c5-c86c52ed7b38",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "0e030276-7ab9-44f1-83ac-cb9033e62607",
                        "ApiEndpoint": "https://zs-api.zsbrasil.com/open-insurance/products-services/v1/home-insurance/commercializationArea/%257bcommercializationArea%257d"
                    }
                ],
                "ApiFamilyType": "products-services_home-insurance",
                "ApiVersion": "1.2"
            },
            {
                "ApiResourceId": "f2aca9e4-705a-4abe-8669-465e45e72ef8",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "4bacb385-519e-483f-b8e5-82850de3220b",
                        "ApiEndpoint": "https://www.api.com/open-insurance/resources/v1"
                    }
                ],
                "ApiFamilyType": "resources",
                "ApiVersion": "1.0.0"
            },
            {
                "ApiResourceId": "fe0cd407-2b58-4cb3-bdc6-82e7d51df919",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "d145d388-c288-48d4-8e65-6cc14a4b2518",
                        "ApiEndpoint": "https://apis.tokiomarine.com.br/open-insurance/products-services/v1/home-insurance/commercializationArea/11700001"
                    }
                ],
                "ApiFamilyType": "products-services_home-insurance",
                "ApiVersion": "1"
            },
            {
                "ApiResourceId": "1b9ac5a4-22bc-4d4a-adb6-e5990fced412",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "3e6e3220-5539-454b-9e85-4c232684d463",
                        "ApiEndpoint": "https://brmodel.chubb.com/opin/api/open-insurance/products-services/v1/transport"
                    }
                ],
                "ApiFamilyType": "products-services_transport",
                "ApiVersion": "1.0.0"
            },
            {
                "ApiResourceId": "36df2309-8c6b-4cd7-bd2e-aed0139adc8f",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "b024e1a2-9a16-4906-8d1e-b02e4d206e73",
                        "ApiEndpoint": "https://api.cnpbrasil.com.br/cnpbrasil/prd/open-insurance/products-services/v1/auto-insurance/32/51306/2001"
                    }
                ],
                "ApiFamilyType": "products-services_auto-insurance",
                "ApiVersion": "1"
            },
            {
                "ApiResourceId": "14a0ddbc-dd96-430c-ba02-bb20467338e9",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "06a85444-4580-4b15-ab21-62b2875e38fa",
                        "ApiEndpoint": "https://eu-brazil.apis.allianz.com/open-insurance/products-services/v1/auto-insurance/22743520/018073/2011"
                    }
                ],
                "ApiFamilyType": "products-services_auto-insurance",
                "ApiVersion": "3.0.0"
            },
            {
                "ApiResourceId": "2bd59719-7ba9-4d18-90c8-572e7dac5b1c",
                "ApiDiscoveryEndpoints": [
                    {
                        "ApiDiscoveryId": "7b267a39-c692-4f86-8117-f47cfb357ef2",
                        "ApiEndpoint": "https://api.icatuseguros.com.br/open-insurance/channels/v1/intermediary/"
                    }
                ],
                "ApiFamilyType": "channels_intermediary",
                "ApiVersion": "1.0.0"
            }
        ],
        "AutoRegistrationSupported": true,
        "CustomerFriendlyLogoUri": "https://www.unused.com/.svg",
        "DeveloperPortalUri": null,
        "AuthorisationServerId": "5181bade-1214-4465-8fdb-129bc8f313e3",
        "Organisation": {
            "OrganisationId": "fe638203-153c-4915-b80a-2ca470a3b25c",
            "Status": "Active",
            "OrganisationName": "OPEN INSURANCE BRASIL - RAIDIAM",
            "CreatedOn": "2022-02-18T20:53:08.136Z",
            "LegalEntityName": "Raidiam Services Ltd",
            "CountryOfRegistration": "UK",
            "CompanyRegister": "VAT Number",
            "RegistrationNumber": "00000010742851",
            "RegisteredName": "Raidiam Services Ltd",
            "AddressLine1": "199 Bishopsgate",
            "AddressLine2": "Vila",
            "City": "London",
            "Postcode": "EC2M 3TY",
            "Country": "UK",
            "ParentOrganisationReference": "",
            "RequiresParticipantTermsAndConditionsSigning": false,
            "AuthorityClaims": [
                {
                    "Status": "Active",
                    "AuthorisationDomain": "Raidiam",
                    "Role": "Dev",
                    "RegistrationId": "21345678"
                }
            ]
        }
    }
]




Validado que as duas marcas existentes no Diretório constam no postman.

:thumbsdown: Jornada negativa

Informado um CNPJ inexistente. O retorno foi de acordo com o esperado.




Atualizado em 09/03/2023

Português, Brasil