Endpoint para verificação dos servidores de aplicação e código do aplicativo

CONTEÚDO

1. Visão geral
2. Exemplo de utilização
3. Assuntos relacionados

01. VISÃO GERAL

Há a necessidade de verificação se o cliente possui um broker cadastrado para um determinado aplicativo e com alias *, para a empresa que o usuário está logado.

Para sanar esta necessidade, a partir da release 12.1.2209 foi implementado um endpoint api/utp/v1/appCompanyBroker que retorna informações que posteriormente podem ser utilizadas para a correta utilização do broker.

02. EXEMPLO DE UTILIZAÇÃO

1. O endpoint em questão deve ser acessado por um método POST, com o modelo de autenticação Basic Auth passado como parâmetro um usuário e senha (interno) do produto TOTVS - Linha Datasul.

Figura 1 - Exemplo de chamada ao endpoint

Abaixo o modelo de requisição da Header enviada, sendo necessário substituir o conteúdo <ENCODE_BASIC> seguindo o modelo do Basic Authentication

Request Headers
Authorization: Basic <ENCODE_BASIC>
Content-Type: application/json

2. O atributo relacionado ao código do aplicativo deve ser enviado no formato application/json com o seguinte conteúdo:

Figura 2 - Modelo do parâmetro enviado na Body

Abaixo a definição dos valores, onde o <CODIGO_APLICATIVO> deve ser substituído pelo identificador (em string) relacionado ao cadastro do servidor de aplicação.

Request Body
{
    "appCode": "<CODIGO_APLICATIVO>"
}

Exemplo:

Com o cadastro definido no programa BTB962AA, o <CODIGO_APLICATIVO> será o valor definido no campo em destaque:

Figura 3 - Cadastro do Servidor Aplicação em BTB962AA

4. A busca é realizada de acordo com o código do aplicativo informado, considerando sempre o alias *, cujo o retorno será uma lista de empresas relacionadas ao usuário enviado na autenticação (SEC000AA - Aba Empresa), com o atributo do aplicativo cadastrado no programa BTB962AA.

Figura 4 - Json de retorno do endpoint 

Caso o parâmetro não seja enviado ou não seja encontrado um Aplicativo relacionado ao código enviado, é retornado uma lista vazia.

Figura 5 - Retorno vazio quando não encontrado os parâmetros 

03. ASSUNTOS RELACIONADOS

• TOTVS Broker Escalável: https://tdn.totvs.com/pages/releaseview.action?pageId=654953316
• Desenvolvimento de APIs para o produto Datasul: https://tdn.totvs.com/pages/releaseview.action?pageId=517117610