FAQs - Suporte técnico

Cross Segmento - TOTVS Backoffice (Linha Protheus) - ADVPL - Como criar um serviço REST no protheus

Dúvida
O que eu preciso para criar um serviço REST no protheus?

Ambiente
Cross Segmento - TOTVS Backoffice (Linha Protheus) – ADVPL – A partir da versão 12

Solução
Antes de começar o desenvolvimento de sua aplicação , certifique-se que o ambiente está configurado para utilização do WebService REST (veja em saiba mais).

Para criar um serviço REST, utilizamos a classe WSRESTFUL, onde através dela iremos publicar nosso serviço e declarar e desenvolver nossos métodos GET,POST,PUT e DELETE. É importante ressaltar que hoje o produto só suporta esses métodos.

Vamos iniciar nosso fonte, declarando os includes necessário para a utilização da classe.
*Importante: Estar com os includes sempre atualizados conforme o portal de download.

#INCLUDE 'totvs.ch'
#INCLUDE 'restful.ch'

Depois disso iremos criar a classe WSRESTFUL informando um nome  helloworld(nome), uma descrição DESCRIPTION "Meu Primeiro serviço REST!" e o fechamento da classe com END WSRESTFUL.

WSRESTFUL helloworld DESCRIPTION "Meu Primeiro serviço REST!"

END WSRESTFUL

 Vamos também declarar os métodos que vamos ter na nossa classe. Para isso utilizamos o comando WSMETHOD, indicaremos o nome do método e uma descrição para ele:

WSMETHOD GET DESCRIPTION "Retornar um Hello World"

Com isso, só nos resta desenvolver o método que declaramos, para isso utilizaremos novamente o método WSMETHOD, só que agora vamos "amarrar" ele a nossa classe usando o comando WSSERVICE, que serve para indicar a qual classe o método pertence. Usaremos também o SetResponse, que serve para informar a resposta da requisição, e ao fim daremos o Return, para o programa entender que finalizamos o desenvolvimento do nosso método.

*importante: O retorno precisa ser logico.

WSMETHOD GET WSSERVICE helloworld
    ::setResponse('[{"Status":"Hello World"}]')
return .T.

Ao final de nosso desenvolvimento, teremos o seguinte resultado:

#include "protheus.ch"
#include "restful.ch"

WSRESTFUL helloworld DESCRIPTION "Meu Primeiro serviço REST!"
    WSMETHOD GET DESCRIPTION "Retornar um Hello World" 
END WSRESTFUL

WSMETHOD GET WSSERVICE helloworld
    ::setResponse('[{"Status":"Hello World"}]')
return .T.

Após compilar esse exemplo, será necessário reiniciar o seu AppServer, para que o seu serviço seja publicado na lista de API's.

O exemplo acima é básico, para desenvolvedores que nunca tiveram contato com WS em ADVPL, e serve para dar um "norte" ao desenvolvedor que quer construir suas API's

Saiba Mais:
Cross Segmento - TOTVS Backoffice (Linha Protheus) - ADVPL - Configuração básica REST do protheus
Cross Segmento - TOTVS Backoffice (Linha Protheus) - ADVPL - Criação de Web Service REST

Esse artigo foi útil?
Usuários que acharam isso útil: 0 de 0

0 Comentários

Por favor, entre para comentar.
X Fechar

Olá ,

Há pendência referente a um de seus produtos contratados para a empresa ().

Entre em contato com o Centro de Serviços TOTVS para tratativa.

Ligue! 4003-0015 opção 4 e 9 ou registre uma solicitação para CST – Cobrança – Verificação de pendências financeiras . clique aqui.

TOTVS

X Fechar

Olá ,

Seu contato não está cadastrado no Portal do Cliente como um perfil autorizado a solicitar consultoria telefônica.

Por gentileza, acione o administrador do Portal de sua empresa para: (1)configurar o seu acesso ou (2)buscar um perfil autorizado para registro desse atendimento.

Em caso de dúvidas sobre a identificação do contato administrador do Portal, ligue (11) 4003-0015, opção 7 e, em seguida, opção 4 para buscar o suporte com o time de Assessoria ao Portal do Cliente. . clique aqui.

TOTVS

X Fechar

Olá ,

Para o atendimento de "Consultoria Telefônica" você deverá estar de acordo com o Faturamento.

TOTVS

X Fechar

Olá,

Algo inesperado ocorreu, e o usuario nao foi reconhecido ou você nao se encontra logado

Por favor realize um novo login

Em caso de dúvidas, entre em contato com o administrador do Portal de Clientes de sua empresa para verificação do seu usuário, ou Centro de Serviços TOTVS.

Ligue! 4003-0015 opção 4 e 9 ou registre uma solicitação para CST – Cadastros . clique aqui.

TOTVS

Chat _

Preencha os campos abaixo para iniciar o atendimento:

Chat _