Árvore de páginas

Versões comparadas

Chave

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


CONTEÚDO

  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
  6. Cadastro Api


01. VISÃO GERAL

Esse programa permite realizar o cadastro das apis do Produto Datasul e gerenciar permissões.

Tem como objetivo facilitar o cadastro das api's APIs e ter todas as informações centralizadas. 

Matriz de Evolução

Versão / Release

Funcionalidade

12.1.2507Liberação do programa

02. EXEMPLO DE UTILIZAÇÃO

03. TELA XXXXX

Outras Ações / Ações relacionadas

...

04. TELA XXXXX

Principais Campos e Parâmetros

...

Card documentos
InformacaoUse esse box para destacar informações relevantes e/ou de destaque.
TituloIMPORTANTE!

...

Para acessar o cadastro de APIs, no menu, pesquise por "html.apis-maintenance". O programa aparecerá na aba "Tarefas", para acessá-lo, basta clicar no programa e em seguida no botão "Executar". 

03. Tela Cadastro APIs

Na tela principal vai mostrar a listagem das APIs:

Image Added

Botão adicionar:

Permite adicionar uma nova api.

Image Added

Quando informado os campos e clicar em confirmar serão buscadas todas as rotas encontrada para a api.

Irá mostrar uma mensagem se deseja criar os registros conforme rotas e métodos encontrados.  Caso clique em cancelar o registro não é criado.

Image Added

CamposDescrição
Tipo de registroRegistros criados são sempre do tipo "Customizado"
NomeNome da api 
Nome ExternoNome físico, caminho relativo e completo do programa.
Importante: Deve ser utilizada a barra normal "/" para englobar todas as possibilidades de pesquisa, geração de Json e de execução em diferentes SO.
DescriçãoDescrição do nome da api
UPCInserir chamada do programa para customizar a funcionalidade do programa padrão do Produto Datasul. No atributo Programa UPC (User Program Call), pode ser informado o caminho e nome físico do programa de customização a ser executado, caso exista.
Veja mais informações na descrição do Guia BTB (Tabelas Básicas) – Manter Dicionário Datasul.
Importante: Detalhes sobre o processo de Customização do Produto (EPC), UPC (programas customizados dos clientes), o funcionamento, criação, relacionamento no produto, é efetuado na função Manutenção de Programas/Manutenção Dicionário Datasul do módulo Básico.
A documentação disponível encontra-se no "Guia de Customização para o Produto", contendo estas explicações, e os exemplos de como construir os padrões que devem ser utilizados.  

Opção editar:

Permite alterar o registro. É permitido alterar apenas descrição da api e UPC.

Nessa tela são apresentadas as rotas

Image Added

Nas Rotas de Api é possível editar a rota. É permitido alterar apenas a descrição.

Image Added

Botão atualizar:

Ao clicar em "Atualizar", o sistema compara as rotas que já estão cadastradas com as rotas disponíveis atualmente na API. Se forem encontradas diferenças, ele exibe uma listagem com essas alterações e aguarda a confirmação do usuário para prosseguir com a atualização. Caso não haja nenhuma diferença, uma mensagem é exibida informando que as rotas já estão atualizadas.

Image Added


Ações em cada registro da api:

Image Added

Gerenciar permissões:

Na opção gerenciar permissões permite adicionar grupos de segurança e permissões para a rota.

Image Added

É possível escolher a rota, adicionar ou escolher um grupo de segurança para a rota e adicionar permissões para o grupo.

Image Added

Botão adicionar do grupo de segurança apresenta os grupos de usuários disponíveis.

Image Added

Ao marcar ou desmarcar uma permissão de grupo será salvo e também salva grupo de segurança.

Image Added