Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice


       

Índice
exclude.*ndice
printablefalse

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 Agent envia uma requisição na rota de configuração de integração retornada pelo ERP, informando sua o endereço base do Smart View e o endereço da 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:


Bloco de código
themeRDark
titleintegrations_setup_uri Response Body
{
    
    "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:

Aviso

A API de Configuração da Integração com o Smart View deve ser autenticada utilizando um token JWT fornecida pelo ERP.

Painel
borderColor#bec0c6
bgColor#f2f5fb
titleColor#FFFFFF
borderWidth1
titleBGColor#919397
borderStylesolid
titleEndpoint
Bloco de código
themeRDark
POST https://exemplo.com/integrations/smart-view
Header: Authorization Bearer TokenJWT
Bloco de código
languagejs
themeRDark
titlePayload da Requisição
{     
    "smartViewBaseUrlsmartViewPublicUri" : "http://hostname:7017/",
    "smartViewReadinessUrlsmartViewHealthCheckUri": "http://hostname:7017/api/_/health/readiness"
}

Os possíveis retornos são:

  • 204 - Caso o ERP consiga estabelecer comunicação com o Smart View e tenha realizado a configuração da integração;
  • 500 - Caso ocorra um erro na comunicação e/ou configuração da integração, retornando a descrição do erro no Response.
Dica

O endpoint _/health/readiness do Smart View retorna um 200 caso a aplicação esteja saudável.

Versões dos ERPs que suportam esse fluxo de configuração


Linha de ERPVersão
RM12.1.2410
Protheusà definir
Datasulà definir




Informações
iconfalse
Informações
iconfalse

Produto: Framework

Informações
iconfalse

Processo: Smart View

Informações

Versão: 3.X

Informações
iconfalse
Informações
iconfalse

Status: Rascunho

Informações
iconfalse

Data:  

Informações
iconfalse

Autores
 Henrique Santos de Aguiar

Cesar Henrique Silva Rodrigues_ 



Page Tree