Histórico da Página
Aviso | ||
---|---|---|
| ||
O conteúdo relacionado na página abaixo foi substituído e será descontinuado em releases futuras.A nova técnica para desenvolvimento de API poderá ser consultada através do seguinte endereço (http://tdn.totvs.com/x/6BE4Fw) e esta disponível a partir da release 12.1.22 do Logix. |
A declaração do nome da função terá fundamental importância neste desenvolvimento, pois é isso que definirá se a função da API ficará pública e como será a execução da função a partir de serviços web. Segue abaixo um exemplo de definição:
...
Seguindo o padrão de desenvolvimento atual, todas as funções da API devem iniciar com o nome do objeto de negócio correspondente.
Exemplos:
Objeto de Negócio | Função |
---|---|
supr0004 | supr0004_pub_update_item, supr4_pub_delete_item |
manr0099 | manr0099_pub_delete_estrutura, manr99_verifica_estrutura |
obfr0021 | obfr0021_atualiza_nota, obfr21_process_emiteNota |
1.3 Identificador de Publicação
...
Abaixo segue a tabela de conversão dos métodos HTTP para o método de execução das funções 4GL:
Método de Execução | Método HTTP | Objetivo |
---|---|---|
create | POST | Criação de um ou mais registros. |
process | POST | Processamento de dados ou geração de relatórios. |
update | PUT | Atualização de um ou mais registros. |
get | GET | Consulta a um ou mais registros. |
delete | DELETE | Exclusão de um ou mais registros. |
Os métodos de requisições HTTP existentes podem ser consultados através deste link: http://www.w3schools.com/tags/ref_httpmethods.asp.
...
Segue abaixo exemplo de definição de funções e como será realizada a requisição web de execução destas funções:
Função | Requisição |
---|---|
|
|
FUNCTION obfr0010_pub_process_emailTransportadora() |
|
FUNCTION supr0010_pub_update_estoqueProprio() |
|
FUNCTION manr0021_pub_get_apontamento_horas() | GET /logix-rest/manr21/apontamento_hora |