Linha Microsiga Protheus

Árvore de páginas

CONTEÚDO

  1. Visão Geral
  2. Serviços Disponíveis
  3. Exemplo de utilização
    1. GET
    2. POST
    3. PUT
    4. DELETE
  4. Assuntos Relacionados

01. VISÃO GERAL

Para clientes que possuem aplicativos customizados e precisam consultar ou manipular as informações na rotina Complemento de Produtos (MATA180), foram disponibilizados métodos Web Service REST.

02. SERVIÇOS DISPONÍVEIS

GET
Consulta

POST
Inclusão

PUT
Alteração		DELETE
Exclusão
(seleção)(seleção)(seleção)(seleçã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 exemplos a seguir serão demonstrados utilizando a extensão PostCode do programa VSCODE, executando os métodos GET, POST, PUT e DELETE.

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.

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"

models: é um vetor com os submodelos do modelo de dados do MVC, definido por:

id: é o submodelo de dados definido no MVC

modeltype: é tipo de modelo de dados, "FIELDS" ou "GRID"

items: é um vetor definindo os itens do GRID, definido por:

id: é um sequêncial do vetor dos itens,

deleted: indica se o registro é deletado ou não, valor padrão: 0,

fields: é um vetor com os campos e valores dos itens do GRID, definido por: 

id: é nome do campo

value: é o valor do campo

Modelo Estrutura 
{
	"id": "MATA180",
	"operation": 1,
	"pk": "RCBNRyAwMSBFU1RTRTAwMDAwMDAwMDAwMDAwMDAwMDAwMjg4OTY=",
	"models": [
		{
			"id": "SB5MASTER",
			"modeltype": "FIELDS",
			"fields": [
				{
					"id": "B5_FILIAL",
					"order": 1,
					"value": "D MG 01"
				},
				{
					"id": "B5_COD",
					"order": 2,
					"value": "ESTSE0000000000000000000028896"
				},
				{
					"id": "B5_CEME",
					"order": 9,
					"value": "TESTE API MATA180"
				},
				{
					"id": "B5_CARPER",
					"order": 25,
					"value": "2"
				},
				{
					"id": "B5_ROTACAO",
					"order": 37,
					"value": "2"
				},
				{
					"id": "B5_UMIND",
					"order": 44,
					"value": "1"
				},
				{
					"id": "B5_PORTMS",
					"order": 54,
					"value": "2"
				},
				{
					"id": "B5_NPULMAO",
					"order": 55,
					"value": "1"
				},
				{
					"id": "B5_TIPUNIT",
					"order": 93,
					"value": "1"
				},
				{
					"id": "B5_QTDVAR",
					"order": 94,
					"value": "2"
				},
				{
					"id": "B5_IMPETI",
					"order": 95,
					"value": "1"
				},
				{
					"id": "B5_VLDOPER",
					"order": 96,
					"value": "1"
				},
				{
					"id": "B5_NSERIE",
					"order": 100,
					"value": "N"
				},
				{
					"id": "B5_REVPROD",
					"order": 116,
					"value": "2"
				},
				{
					"id": "B5_TPSERV",
					"order": 117,
					"value": "1"
				},
				{
					"id": "B5_SEMENTE",
					"order": 118,
					"value": "2"
				},
				{
					"id": "B5_FORMMRP",
					"order": 124,
					"value": "1"
				},
				{
					"id": "B5_AGLUMRP",
					"order": 140,
					"value": "1"
				},
				{
					"id": "B5_BLQINVA",
					"order": 143,
					"value": "2"
				},
				{
					"id": "B5_MONTA",
					"order": 146,
					"value": "2"
				},
				{
					"id": "B5_INTDI",
					"order": 156,
					"value": "2"
				},
				{
					"id": "B5_INDPETR",
					"order": 157,
					"value": "0"
				},
				{
					"id": "B5_TPISERV",
					"order": 170,
					"value": "5"
				},
				{
					"id": "B5_ECFLAG",
					"order": 174,
					"value": "2"
				},
				{
					"id": "B5_CTRWMS",
					"order": 178,
					"value": "2"
				},
				{
					"id": "B5_TIPO",
					"order": 195,
					"value": "1"
				},
				{
					"id": "B5_DEC7174",
					"order": 196,
					"value": "2"
				},
				{
					"id": "B5_WMSEMB",
					"order": 197,
					"value": "2"
				},
				{
					"id": "B5_ISIDUNI",
					"order": 223,
					"value": "1"
				},
				{
					"id": "B5_INSSPAT",
					"order": 224,
					"value": "2"
				},
				{
					"id": "B5_VLZERO",
					"order": 225,
					"value": "2"
				},
				{
					"id": "B5_ECDESF",
					"order": 226,
					"value": "1"
				},
				{
					"id": "B5_ISDSHIP",
					"order": 234,
					"value": "0"
				},
				{
					"id": "B5_TAKEUP",
					"order": 237,
					"value": "2"
				}
			]
		}
	]
}

    1. GET


      Retorno:

      Retorno Get 
      {
	"id": "MATA180",
	"operation": 1,
	"pk": "RCBNRyAwMSBFU1RTRTAwMDAwMDAwMDAwMDAwMDAwMDAwMjg4OTY=",
	"models": [
		{
			"id": "SB5MASTER",
			"modeltype": "FIELDS",
			"fields": [
				{
					"id": "B5_FILIAL",
					"order": 1,
					"value": "D MG 01"
				},
				{
					"id": "B5_COD",
					"order": 2,
					"value": "ESTSE0000000000000000000028896"
				},
				{
					"id": "B5_CEME",
					"order": 9,
					"value": "TESTE API MATA180"
				},
				{
					"id": "B5_CARPER",
					"order": 25,
					"value": "2"
				},
				{
					"id": "B5_ROTACAO",
					"order": 37,
					"value": "2"
				},
				{
					"id": "B5_UMIND",
					"order": 44,
					"value": "1"
				},
				{
					"id": "B5_PORTMS",
					"order": 54,
					"value": "2"
				},
				{
					"id": "B5_NPULMAO",
					"order": 55,
					"value": "1"
				},
				{
					"id": "B5_TIPUNIT",
					"order": 93,
					"value": "1"
				},
				{
					"id": "B5_QTDVAR",
					"order": 94,
					"value": "2"
				},
				{
					"id": "B5_IMPETI",
					"order": 95,
					"value": "1"
				},
				{
					"id": "B5_VLDOPER",
					"order": 96,
					"value": "1"
				},
				{
					"id": "B5_NSERIE",
					"order": 100,
					"value": "N"
				},
				{
					"id": "B5_REVPROD",
					"order": 116,
					"value": "2"
				},
				{
					"id": "B5_TPSERV",
					"order": 117,
					"value": "1"
				},
				{
					"id": "B5_SEMENTE",
					"order": 118,
					"value": "2"
				},
				{
					"id": "B5_FORMMRP",
					"order": 124,
					"value": "1"
				},
				{
					"id": "B5_AGLUMRP",
					"order": 140,
					"value": "1"
				},
				{
					"id": "B5_BLQINVA",
					"order": 143,
					"value": "2"
				},
				{
					"id": "B5_MONTA",
					"order": 146,
					"value": "2"
				},
				{
					"id": "B5_INTDI",
					"order": 156,
					"value": "2"
				},
				{
					"id": "B5_INDPETR",
					"order": 157,
					"value": "0"
				},
				{
					"id": "B5_TPISERV",
					"order": 170,
					"value": "5"
				},
				{
					"id": "B5_ECFLAG",
					"order": 174,
					"value": "2"
				},
				{
					"id": "B5_CTRWMS",
					"order": 178,
					"value": "2"
				},
				{
					"id": "B5_TIPO",
					"order": 195,
					"value": "1"
				},
				{
					"id": "B5_DEC7174",
					"order": 196,
					"value": "2"
				},
				{
					"id": "B5_WMSEMB",
					"order": 197,
					"value": "2"
				},
				{
					"id": "B5_ISIDUNI",
					"order": 223,
					"value": "1"
				},
				{
					"id": "B5_INSSPAT",
					"order": 224,
					"value": "2"
				},
				{
					"id": "B5_VLZERO",
					"order": 225,
					"value": "2"
				},
				{
					"id": "B5_ECDESF",
					"order": 226,
					"value": "1"
				},
				{
					"id": "B5_ISDSHIP",
					"order": 234,
					"value": "0"
				},
				{
					"id": "B5_TAKEUP",
					"order": 237,
					"value": "2"
				}
			]
		}
	]
}

    2. POST

      Importante

      Não informar a PK (Primary Key) no path.



      Retorno:

      Retorno Post 
      {
	"id": "MATA180",
	"operation": 1,
	"pk": "RCBNRyAwMSBFU1RTRTAwMDAwMDAwMDAwMDAwMDAwMDAwMjg4OTY=",
	"models": [
		{
			"id": "SB5MASTER",
			"modeltype": "FIELDS",
			"fields": [
				{
					"id": "B5_FILIAL",
					"order": 1,
					"value": "D MG 01"
				},
				{
					"id": "B5_COD",
					"order": 2,
					"value": "ESTSE0000000000000000000028896"
				},
				{
					"id": "B5_CEME",
					"order": 9,
					"value": "TESTE API MATA180"
				},
				{
					"id": "B5_CARPER",
					"order": 25,
					"value": "2"
				},
				{
					"id": "B5_ROTACAO",
					"order": 37,
					"value": "2"
				},
				{
					"id": "B5_UMIND",
					"order": 44,
					"value": "1"
				},
				{
					"id": "B5_PORTMS",
					"order": 54,
					"value": "2"
				},
				{
					"id": "B5_NPULMAO",
					"order": 55,
					"value": "1"
				},
				{
					"id": "B5_TIPUNIT",
					"order": 93,
					"value": "1"
				},
				{
					"id": "B5_QTDVAR",
					"order": 94,
					"value": "2"
				},
				{
					"id": "B5_IMPETI",
					"order": 95,
					"value": "1"
				},
				{
					"id": "B5_VLDOPER",
					"order": 96,
					"value": "1"
				},
				{
					"id": "B5_NSERIE",
					"order": 100,
					"value": "N"
				},
				{
					"id": "B5_REVPROD",
					"order": 116,
					"value": "2"
				},
				{
					"id": "B5_TPSERV",
					"order": 117,
					"value": "1"
				},
				{
					"id": "B5_SEMENTE",
					"order": 118,
					"value": "2"
				},
				{
					"id": "B5_FORMMRP",
					"order": 124,
					"value": "1"
				},
				{
					"id": "B5_AGLUMRP",
					"order": 140,
					"value": "1"
				},
				{
					"id": "B5_BLQINVA",
					"order": 143,
					"value": "2"
				},
				{
					"id": "B5_MONTA",
					"order": 146,
					"value": "2"
				},
				{
					"id": "B5_INTDI",
					"order": 156,
					"value": "2"
				},
				{
					"id": "B5_INDPETR",
					"order": 157,
					"value": "0"
				},
				{
					"id": "B5_TPISERV",
					"order": 170,
					"value": "5"
				},
				{
					"id": "B5_ECFLAG",
					"order": 174,
					"value": "2"
				},
				{
					"id": "B5_CTRWMS",
					"order": 178,
					"value": "2"
				},
				{
					"id": "B5_TIPO",
					"order": 195,
					"value": "1"
				},
				{
					"id": "B5_DEC7174",
					"order": 196,
					"value": "2"
				},
				{
					"id": "B5_WMSEMB",
					"order": 197,
					"value": "2"
				},
				{
					"id": "B5_ISIDUNI",
					"order": 223,
					"value": "1"
				},
				{
					"id": "B5_INSSPAT",
					"order": 224,
					"value": "2"
				},
				{
					"id": "B5_VLZERO",
					"order": 225,
					"value": "2"
				},
				{
					"id": "B5_ECDESF",
					"order": 226,
					"value": "1"
				},
				{
					"id": "B5_ISDSHIP",
					"order": 234,
					"value": "0"
				},
				{
					"id": "B5_TAKEUP",
					"order": 237,
					"value": "2"
				}
			]
		}
	]
}

    3. PUT



      Retorno:

      Retorno Put 
      {
	"id": "MATA180",
	"operation": 1,
	"pk": "RCBNRyAwMSBFU1RTRTAwMDAwMDAwMDAwMDAwMDAwMDAwMjg4OTY=",
	"models": [
		{
			"id": "SB5MASTER",
			"modeltype": "FIELDS",
			"fields": [
				{
					"id": "B5_FILIAL",
					"order": 1,
					"value": "D MG 01"
				},
				{
					"id": "B5_COD",
					"order": 2,
					"value": "ESTSE0000000000000000000028896"
				},
				{
					"id": "B5_CEME",
					"order": 9,
					"value": "TESTE API MATA180 PUT"
				},
				{
					"id": "B5_CARPER",
					"order": 25,
					"value": "2"
				},
				{
					"id": "B5_ROTACAO",
					"order": 37,
					"value": "2"
				},
				{
					"id": "B5_UMIND",
					"order": 44,
					"value": "1"
				},
				{
					"id": "B5_PORTMS",
					"order": 54,
					"value": "2"
				},
				{
					"id": "B5_NPULMAO",
					"order": 55,
					"value": "1"
				},
				{
					"id": "B5_TIPUNIT",
					"order": 93,
					"value": "1"
				},
				{
					"id": "B5_QTDVAR",
					"order": 94,
					"value": "2"
				},
				{
					"id": "B5_IMPETI",
					"order": 95,
					"value": "1"
				},
				{
					"id": "B5_VLDOPER",
					"order": 96,
					"value": "1"
				},
				{
					"id": "B5_NSERIE",
					"order": 100,
					"value": "N"
				},
				{
					"id": "B5_REVPROD",
					"order": 116,
					"value": "2"
				},
				{
					"id": "B5_TPSERV",
					"order": 117,
					"value": "1"
				},
				{
					"id": "B5_SEMENTE",
					"order": 118,
					"value": "2"
				},
				{
					"id": "B5_FORMMRP",
					"order": 124,
					"value": "1"
				},
				{
					"id": "B5_AGLUMRP",
					"order": 140,
					"value": "1"
				},
				{
					"id": "B5_BLQINVA",
					"order": 143,
					"value": "2"
				},
				{
					"id": "B5_MONTA",
					"order": 146,
					"value": "2"
				},
				{
					"id": "B5_INTDI",
					"order": 156,
					"value": "2"
				},
				{
					"id": "B5_INDPETR",
					"order": 157,
					"value": "0"
				},
				{
					"id": "B5_TPISERV",
					"order": 170,
					"value": "5"
				},
				{
					"id": "B5_ECFLAG",
					"order": 174,
					"value": "2"
				},
				{
					"id": "B5_CTRWMS",
					"order": 178,
					"value": "2"
				},
				{
					"id": "B5_TIPO",
					"order": 195,
					"value": "1"
				},
				{
					"id": "B5_DEC7174",
					"order": 196,
					"value": "2"
				},
				{
					"id": "B5_WMSEMB",
					"order": 197,
					"value": "2"
				},
				{
					"id": "B5_ISIDUNI",
					"order": 223,
					"value": "1"
				},
				{
					"id": "B5_INSSPAT",
					"order": 224,
					"value": "2"
				},
				{
					"id": "B5_VLZERO",
					"order": 225,
					"value": "2"
				},
				{
					"id": "B5_ECDESF",
					"order": 226,
					"value": "1"
				},
				{
					"id": "B5_ISDSHIP",
					"order": 234,
					"value": "0"
				},
				{
					"id": "B5_TAKEUP",
					"order": 237,
					"value": "2"
				}
			]
		}
	]
}

    4. DELETE

      Importante

      Para realizar a deleção do registro, deve informar somente o path sem a estrutura (body).



04. ASSUNTOS RELACIONADOS

FWRestModel - API RESTful dos modelos de dados do Protheus

Integração do Easy Import Control via API REST

Catálogo de Produtos via API REST