Linha Microsiga Protheus

Árvore de páginas

Versões comparadas

Versão antiga 9

changes.mady.by.user Rafael Tenorio da Costa

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Rafael Tenorio da Costa

Gravado em

Chave

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

Ponto de Entrada - PSHRestFi 

Este Ponto de Entrada é executado na rotina LojRestObj20, após as gravações do execAuto das APIs do Protheus Smart Hub.

Para consultar a lista de APIs compativeis, acesse; APIs Protheus Smart Hub

Descrição:

APIs Integração Protheus

Eventos:

Protected Method execAuto()

Programa Fonte:

LojRestObj20

Função:

PSHRestFi

Parâmetos:

Nome

Tipo

Descrição

ParamIxb

self:cBody

 Caractere

Body da requisição no formato Json com as informações enviada no Post ParamIxb[1]
self:lSuccessLógico Atributo de controle para validação de sucesso.ParamIxb[2]
self:cErrorCaractereAtributo para retorno de mensagem no request da API em caso de insucesso.ParamIxb[3]
self:oWsRestObj:URNCaractere/api/retail/v1/notaentrada/devolucao ParamIxb[4]

Retorno:

Nome

Tipo

Descrição

Obrigatório

 NIL

NIL

Para o ponto de entrada PSHRestFi não é tratado retorno após a gravação dos dados de executo

não

 

Exemplo de Codificação:

Bloco de código
User Function PSHRESTFI()
 


	Local
cBody         
 cBody		:= ParamIxb[1] 


	Local lSuccess
     
 	:= ParamIxb[2]


	Local cError   
     
	:= ParamIxb[3]


	Local cURN     
   
	:= ParamIxb[4]


	Local oBody   
   
 	:= JsonObject():New()



	If lSuccess .AND. "devolucao" $ cURN  //← Faz a proteção para identificar qual API-EndPoint está executando o ponto de entrada.


	   


	    oBody:FromJson( cBody)


	     //Chama Gravação de Cliente......


	    lSuccess := .T.


	    cError   := ""

EndifReturn 


	Endif

Return nil



Ponto de Entrada - PSHRestVL

Este Ponto de Entrada é executado na rotina LojRestObj20, na pre-validação das APIs de Integração Protheus Smart Hub.

Descrição:

APIs Integração Protheus

Eventos:

Protected Method Validation()

Programa Fonte:

LojRestObj20

Função:

PSHRestVL

Parâmetos:

Nome

Tipo

Descrição

ParamIxb

self:cBody

 Caractere

Body da requisição no formato Json com as informações enviada no Post ParamIxb[1]
self:lSuccessLógico Atributo de controle para validação de sucesso.ParamIxb[2]
self:cErrorCaractereAtributo para retorno de mensagem no request da API em caso de insucesso.ParamIxb[3]
self:oWsRestObj:URNCaractere/api/retail/v1/notaentrada/devolucao ParamIxb[4]

Retorno:

Nome

Tipo

Descrição

Obrigatório

 aExecRet            

Array               

{ lSuccess , cError }                                

SIM

 

Exemplo de Codificação:

Bloco de código
User Function PSHRESTFI()
 


	Local
cBody         
 cBody		:= ParamIxb[1] 


	Local lSuccess
     
	:= ParamIxb[2]


	Local cError   
     
	:= ParamIxb[3]


	Local cURN     
   
	:= ParamIxb[4]


	Local oBody   
   
 	:= JsonObject():New()



	If lSuccess .AND. "devolucao" $ cURN  //← Faz a proteção para identificar qual API-EndPoint está executando o ponto de entrada.


	   


	    oBody:FromJson( cBody)


	     //Chama Gravação de Cliente......


	    lSuccess := .F.


	    cError   := "Cliente com CPF invalido ou em branco!"

EndifReturn 


	Endif

Return {lSuccess, cError}
Exempo


Exemplo do Request:

Bloco de código
{


    "success": false,


    "message": "Cliente com CPF invalido ou em branco!",


    "data": [


        {


            "idRetaguardaNota": "D RJ 02 PEQT0R   UNI",


            "idRetaguardaCredito": "D RJ 02 PEQT0R   UNIANCC",


            "valorCredito": 10


        }


    ],


    "hasNext": false


}