Árvore de páginas

Versões comparadas

Chave

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

...

Para melhorar as configurações de acesso e segurança aos endpoints, a partir da versão 12.1.33 foi implementada uma funcionalidade que restringe o acesso aos mesmos de acordo com o grupo de seguraça segurança dos usuários.

02. EXEMPLO DE UTILIZAÇÃO

...

Totvs custom tabs box
tabsPasso 01, Passo 02, Passo 03, Passo 04
idspasso1,passo2,passo3,passo4
Totvs custom tabs box items
defaultyes
referenciapasso1

Efetue o cadastro da API REST no cadastro de programas, sendo o campo "Nome Externo" com a referencia da URL do endpoint



Nota
titleNota

Com o intuito de simplificar a parametrização e padronizar as configurações das APIs quanto as regras de segurança, log de execução e cadastros de UPCs, a partir da release 12.1.2403 o recomendado é efetuar o cadastro do endpoint seguindo o padrão de nomenclatura dos diretórios Progress.

Exemplo: 

Antes: api/btb/v1/properties (Endereço do endpoint da API)

Depois: btb/api/v1/properties (padrão de diretórios onde o fonte Progress responderá a API) 



Exemplos: 

Até 12.1.2403Acima da versão 12.1.2403 

URL: http://<SERVIDOR>:<PORTA>/api/btb/v1/properties

Nome Externo: api/btb/v1/properties

Image Modified

URL: http://<SERVIDOR>:<PORTA>/api/btb/v1/properties

Nome Externo: btb/api/v1/properties


Totvs custom tabs box items
defaultno
referenciapasso2

Na aba Opções, selecione o tipo de Template API REST

Totvs custom tabs box items
defaultno
referenciapasso3

Efetue a configuração do(s) grupo(s) de segurança desejados

Totvs custom tabs box items
defaultno
referenciapasso4

Será permitido o acesso caso o usuário que efetuou a autenticação ao endpoint possua o mesmo grupo que foi configurado anteriormente

  • Caso seja permitido o acesso, será retornado o HTTP Status 200 com o resultado da requisição
  • Caso o acesso não seja permitido, será retornado o HTTP Status 403



Dica
titleDica

Formatos deste exemplo segue o template:

PADRÃO NOVO API - /API

"{protocolo}://{host}/{api}/{modulo}/{versao}/{recurso}"


A segurança do endpoint não considera os possíveis "Path Parameters" enviados na URL.

Para o exemplo acima, todos os parâmetros enviados após o /properties, seguirão as mesmas regras de segurança da URL "principal".

Na prática significa que as URLs com parâmetros apresentadas abaixo serão autorizadas ou bloqueadas mediante ao cadastro anterior.

URL: http://<SERVIDOR>:<PORTA>/api/btb/v1/properties/email

URL: http://<SERVIDOR>:<PORTA>/api/btb/v1/properties/fluig

URL: http://<SERVIDOR>:<PORTA>/api/btb/v1/properties/access

...

Para mais detalhes quanto a definição das URLs, consultar o Guia API TOTVS: https://tdn.totvs.com/x/nDUxE


Os endpoints abaixos seguem regras específicas para desconsiderar os pathParameters enviados na URL

PADRÃO COMPATIBILIDADE API - /dts/datasul-rest/resources/prg/ ou /totvs-rest/prg/

Deve ser cadastrado o contexto inicial com os três níveis após o contexto (módulo/versão/programa)

Exemplos:

/dts/datasul-rest/resources/prg/fwk/v1/menuUsers

/totvs-rest/prg/fwk/v1/menuUsers


PADRÃO ANTIGO API - /dts/datasul-rest/resources/api/ ou /totvs-rest/api/

Deve ser cadastrado o contexto inicial com os três níveis após o contexto (módulo/submodulo/programa)

Exemplos:

/dts/datasul-rest/resources/api/fwk/properties/propServices

/totvs-rest/api/fwk/properties/propServices


PADRÃO ANTIGO DBO - /dts/datasul-rest/resources/dbo ou /totvs-rest/dbo/

Deve ser cadastrado o contexto inicial com os dois níveis após o contexto (caminho_dbo/chaves_tabela)

Exemplos:

/dts/datasul-rest/resources/dbo/adbo/boad107na

/totvs-rest/dbo/adbo/boad107na

...