Índice

Objetivo

       O objetivo desta página é estabelecer o contrato da API de Configuração da Integração a ser desenvolvida pelos ERPs. Essa API irá permitir que o ERP receba uma requisição de configuração pelo Smart View, possibilitando que sua rota de acesso seja parametrizada sem necessidade de interação pelo usuário.

      O Smart View suportará a configuração facilitada caso o ERP implemente as rotas listadas abaixo, descritas na ADR010002:

• ls_info_uri;
• businessObjects_connector_uri;
• integrations_setup_uri.

Introdução

       Para permitir a configuração automática da integração do Smart View com o ERP, o seguinte fluxo será seguido:

1. Smart View Agent busca a rota de configuração da integração através da rota do Provedor de Segurança (ADR010002);
2. Smart View Agent requisita um token utilizando o usuário informado na etapa de configuração do Smart View;
3. Smart View envia uma requisição na rota de configuração de integração retornada pelo ERP, informando sua API de verificação de integridade;
4. ERP resolve o endereço externo do Smart View e faz uma consulta na API de integridade informada para verificar a comunicação;
5. Caso a comunicação ERP/Smart View seja estabelecida com sucesso, o ERP faz a parametrização do endereço do Smart View e retorna com status code 204.

Os detalhes das APIs que fazem parte desse fluxo estão descritos abaixo.

Definição da rota de configuração da integração com o Smart View

    Na rota integrations_setup_uri definida na ADR010002, a rota de configuração da integração com o Smart View deve ser retornada com a chave com o valor smart-view-integration-setup seguida do endereço da API do ERP conforme exemplo abaixo:

{
    
    "app-name-integration-setup": "https://exemplo.com/integrations/app-name",
    "smart-view-integration-setup": "https://exemplo.com/integrations/smart-view",

}

Contrato da API de Configuração da Integração com o Smart View

   Detalhes da implementação da API de Configuração da Integração com o Smart View a ser implementada pelo ERP:

POST https://exemplo.com/integrations/smart-view
Header: Authorization Bearer TokenJWT

{
    "smart-view-readiness": "api/_/health/readiness"
}