Árvore de páginas

Versões comparadas

Chave

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

...

  1. Visão Geral
  2. Exemplo de utilização
  3. Tela XXX
    1. Outras Ações / Ações relacionadas
  4. Tela XXX
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas

01. VISÃO GERAL

O acesso aos endpoints REST utilizados no produto TOTVS - Linha Datasul, validam somente se o usuário possui acesso ao login do produto, não sendo validado seus respectivos grupos de segurança.

...

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

Exemplo: 

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

Nome Externo: api/btb/v1/properties

Nota
titleImportante

Formatos deste exemplo segue o template:

"{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

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


PADRÃO COMPATIBILIDADE API - /totvs-rest/prg/

Exemplos:

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

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


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

Exemplos:

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

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


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

Exemplos:

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

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

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

...