Linha Microsiga Protheus

Árvore de páginas

CONTEÚDO

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

01. VISÃO GERAL

Para clientes que possuem aplicativos customizados e precisam consultar ou manipular as informações na rotina Produção de Terceiros (MATA037), 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)(erro)(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 exemplo a seguir serão demonstrados utilizando programa Postman, executando os métodos GET, 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"

                     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

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

Envio - Modelo Estrutura PUT 
{
    "id": "MATA037",
    "operation": 1,
    "pk": "RCBNRyAwMSBEIE1HIDAxIHBjcEI4NDAxMDAxICAg",
    "models": [
        {
            "id": "D3KMASTER",
            "modeltype": "FIELDS",
            "fields": [
                {
                    "id": "C2_NUM",
                    "order": 1,
                    "value": "pcpB84"
                },
                {
                    "id": "C2_ITEM",
                    "order": 2,
                    "value": "01"
                },
                {
                    "id": "C2_SEQUEN",
                    "order": 3,
                    "value": "001"
                }
            ],
            "models": [
                {
                    "id": "SD3DETAIL",
                    "modeltype": "GRID",
                    "struct": [
                        {
                            "id": "D3_COD",
                            "order": 1
                        },
                        {
                            "id": "D3_QUANT",
                            "order": 2
                        },
                        {
                            "id": "D3_CF",
                            "order": 3
                        },
                        {
                            "id": "D3_OP",
                            "order": 4
                        },
                        {
                            "id": "D3_NUMSEQ",
                            "order": 5
                        },
                        {
                            "id": "D3_LOTECTL",
                            "order": 6
                        }
                    ],
                    "items": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "D3_COD",
                                    "value": "ESTSE0000000000000000000013333"
                                },
                                {
                                    "id": "D3_QUANT",
                                    "value": "10.00"
                                },
                                {
                                    "id": "D3_CF",
                                    "value": "PR0"
                                },
                                {
                                    "id": "D3_OP",
                                    "value": "pcpB8401001"
                                },
                                {
                                    "id": "D3_NUMSEQ",
                                    "value": "109506"
                                }
                            ],
                            "models": [
                                {
                                    "id": "D3KDETAIL",
                                    "modeltype": "GRID",
                                    "optional": 1,
                                    "struct": [
                                        {
                                            "id": "D3K_FILIAL",
                                            "order": 1
                                        },
                                        {
                                            "id": "D3K_CLIENT",
                                            "order": 2
                                        },
                                        {
                                            "id": "D3K_LOJA",
                                            "order": 3
                                        },
                                        {
                                            "id": "D3K_OP",
                                            "order": 4
                                        },
                                        {
                                            "id": "D3K_QTDE",
                                            "order": 5
                                        },
                                        {
                                            "id": "D3K_PERBLK",
                                            "order": 6
                                        },
                                        {
                                            "id": "D3K_LOTE",
                                            "order": 7
                                        }
                                    ],
                                    "items": [
                                        {
                                            "id": 1,
                                            "deleted": 0,
                                            "fields": [
                                                {
                                                    "id": "D3K_FILIAL",
                                                    "value": "D MG 01"
                                                },
                                                {
                                                    "id": "D3K_CLIENT",
                                                    "value": "EST001"
                                                },
                                                {
                                                    "id": "D3K_LOJA",
                                                    "value": "01"
                                                },
                                                {
                                                    "id": "D3K_OP",
                                                    "value": "pcpB8401001"
                                                },
                                                {
                                                    "id": "D3K_QTDE",
                                                    "value": "10.00"
                                                },
                                                {
                                                    "id": "D3K_PERBLK",
                                                    "value": "202401"
                                                }
                                            ]
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "id": 2,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "D3_COD",
                                    "value": "ESTSE0000000000000000000013334"
                                },
                                {
                                    "id": "D3_QUANT",
                                    "value": "10.00"
                                },
                                {
                                    "id": "D3_CF",
                                    "value": "RE1"
                                },
                                {
                                    "id": "D3_OP",
                                    "value": "pcpB8401001"
                                },
                                {
                                    "id": "D3_NUMSEQ",
                                    "value": "109506"
                                }
                            ],
                            "models": [
                                {
                                    "id": "D3KDETAIL",
                                    "modeltype": "GRID",
                                    "optional": 1,
                                    "struct": [
                                        {
                                            "id": "D3K_FILIAL",
                                            "order": 1
                                        },
                                        {
                                            "id": "D3K_CLIENT",
                                            "order": 2
                                        },
                                        {
                                            "id": "D3K_LOJA",
                                            "order": 3
                                        },
                                        {
                                            "id": "D3K_OP",
                                            "order": 4
                                        },
                                        {
                                            "id": "D3K_QTDE",
                                            "order": 5
                                        },
                                        {
                                            "id": "D3K_PERBLK",
                                            "order": 6
                                        },
                                        {
                                            "id": "D3K_LOTE",
                                            "order": 7
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}


b. GET

Retorno - Modelo Estrutura GET 
{
    "id": "MATA037",
    "operation": 1,
    "pk": "RCBNRyAwMSBEIE1HIDAxIHBjcEI4NDAxMDAxICAg",
    "models": [
        {
            "id": "D3KMASTER",
            "modeltype": "FIELDS",
            "fields": [
                {
                    "id": "C2_NUM",
                    "order": 1,
                    "value": "pcpB84"
                },
                {
                    "id": "C2_ITEM",
                    "order": 2,
                    "value": "01"
                },
                {
                    "id": "C2_SEQUEN",
                    "order": 3,
                    "value": "001"
                }
            ],
            "models": [
                {
                    "id": "SD3DETAIL",
                    "modeltype": "GRID",
                    "struct": [
                        {
                            "id": "D3_COD",
                            "order": 1
                        },
                        {
                            "id": "D3_QUANT",
                            "order": 2
                        },
                        {
                            "id": "D3_CF",
                            "order": 3
                        },
                        {
                            "id": "D3_OP",
                            "order": 4
                        },
                        {
                            "id": "D3_NUMSEQ",
                            "order": 5
                        },
                        {
                            "id": "D3_LOTECTL",
                            "order": 6
                        }
                    ],
                    "items": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "D3_COD",
                                    "value": "ESTSE0000000000000000000013333"
                                },
                                {
                                    "id": "D3_QUANT",
                                    "value": "10.00"
                                },
                                {
                                    "id": "D3_CF",
                                    "value": "PR0"
                                },
                                {
                                    "id": "D3_OP",
                                    "value": "pcpB8401001"
                                },
                                {
                                    "id": "D3_NUMSEQ",
                                    "value": "109506"
                                }
                            ],
                            "models": [
                                {
                                    "id": "D3KDETAIL",
                                    "modeltype": "GRID",
                                    "optional": 1,
                                    "struct": [
                                        {
                                            "id": "D3K_FILIAL",
                                            "order": 1
                                        },
                                        {
                                            "id": "D3K_CLIENT",
                                            "order": 2
                                        },
                                        {
                                            "id": "D3K_LOJA",
                                            "order": 3
                                        },
                                        {
                                            "id": "D3K_OP",
                                            "order": 4
                                        },
                                        {
                                            "id": "D3K_QTDE",
                                            "order": 5
                                        },
                                        {
                                            "id": "D3K_PERBLK",
                                            "order": 6
                                        },
                                        {
                                            "id": "D3K_LOTE",
                                            "order": 7
                                        }
                                    ],
                                    "items": [
                                        {
                                            "id": 1,
                                            "deleted": 0,
                                            "fields": [
                                                {
                                                    "id": "D3K_FILIAL",
                                                    "value": "D MG 01"
                                                },
                                                {
                                                    "id": "D3K_CLIENT",
                                                    "value": "EST001"
                                                },
                                                {
                                                    "id": "D3K_LOJA",
                                                    "value": "01"
                                                },
                                                {
                                                    "id": "D3K_OP",
                                                    "value": "pcpB8401001"
                                                },
                                                {
                                                    "id": "D3K_QTDE",
                                                    "value": "10.00"
                                                },
                                                {
                                                    "id": "D3K_PERBLK",
                                                    "value": "202401"
                                                }
                                            ]
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "id": 2,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "D3_COD",
                                    "value": "ESTSE0000000000000000000013334"
                                },
                                {
                                    "id": "D3_QUANT",
                                    "value": "10.00"
                                },
                                {
                                    "id": "D3_CF",
                                    "value": "RE1"
                                },
                                {
                                    "id": "D3_OP",
                                    "value": "pcpB8401001"
                                },
                                {
                                    "id": "D3_NUMSEQ",
                                    "value": "109506"
                                }
                            ],
                            "models": [
                                {
                                    "id": "D3KDETAIL",
                                    "modeltype": "GRID",
                                    "optional": 1,
                                    "struct": [
                                        {
                                            "id": "D3K_FILIAL",
                                            "order": 1
                                        },
                                        {
                                            "id": "D3K_CLIENT",
                                            "order": 2
                                        },
                                        {
                                            "id": "D3K_LOJA",
                                            "order": 3
                                        },
                                        {
                                            "id": "D3K_OP",
                                            "order": 4
                                        },
                                        {
                                            "id": "D3K_QTDE",
                                            "order": 5
                                        },
                                        {
                                            "id": "D3K_PERBLK",
                                            "order": 6
                                        },
                                        {
                                            "id": "D3K_LOTE",
                                            "order": 7
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

Importante

Para consultar o registro, deve informar somente o path sem a estrutura (body).


c. 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