CONTEÚDO
- Visão Geral
- Serviços Disponíveis
- Exemplo de utilização
- PUT
- GET
- Assuntos Relacionados
01. VISÃO GERAL
Para clientes que possuem rotinas ou aplicativos customizados e precisam consultar e alterar as informações na rotina Valores Acessórios(FINA040VA), foram disponibilizados métodos Web Service REST.
02. SERVIÇOS DISPONÍVEIS
GET Consulta | POST | PUT Alteração | DELETE Exclusão |
03. EXEMPLO DE UTILIZAÇÃO
Para realizar testes, pode ser utilizado qualquer programa de sua preferência, que teste API Web Service REST.
Como exemplos de programas, podemos citar o SoapUI ou Postman . Ambos são excelentes aplicativos.
Os exemplo a seguir serão demonstrados utilizando programa Postman, executando os métodos GET, POST, PUT e DELETE.
Para inclusão ou alteração do registro, pode utilizar a mesma estrutura (body), os campos podem ser adicionados dentro da tag FIELDS.
Maiores detalhes referente a montagem da estrutura, verificar modelo abaixo.
Onde:
id: é id da API
operation: é o código da operação, valor padrão: 1,
pk: é a chave primária do alias do modelo de dados encodado em base64,
models: são os modelos de negócios de cada API, ou seja, modelo de dados do MVC, que é definido por:
id: é o modelo de dados definido no MVC
modeltype: é tipo de modelo de dados, "FIELDS" ou "GRID"
fields: é um vetor com os campos, definido por:
id: é nome do campo
order: ordem do campo na tabela SBE
value: é o valor do campo
Importante
Por padrão, para realizar consulta, alteração ou deleção de um determinado dado do servidor através dos métodos GET, PUT ou DELETE, é necessário informar a PK (Primary Key), valor da chave primaria do alias do modelo, encodado em base64, caso contrário não informado, serão retornado os registros conforme sua paginação.
a. PUT
b. GET
04. ASSUNTOS RELACIONADOS
FWRestModel - API RESTful dos modelos de dados do Protheus
Integração do Easy Import Control via API REST