Guia Completo para Criar um Serviço REST no TOTVS Protheus e Integrar com APIs Externas

Antes de começarmos, vamos entender o que são serviços REST:

• REST (Representational State Transfer): É um estilo de arquitetura de software para sistemas distribuídos baseados na transferência de estado representacional.
• Serviços REST: São APIs que seguem os princípios REST, utilizando métodos HTTP (GET, POST, PUT, DELETE) para realizar operações em recursos.

Passos para Criar um Serviço REST no Protheus

1. Configuração do Ambiente

1. Verificar a Versão do Protheus:
   • Certifique-se de que sua versão do Protheus suporta a criação de serviços REST.
2. Habilitar o Serviço REST:
   • Ative o serviço REST no arquivo de configuração do appserver.

2. Criar o Programa ADVPL

1. Utilizar a Classe WSRESTFUL:
   • Essa classe é fundamental para a criação e gerenciamento dos serviços REST no Protheus. Confira a documentação da TOTVS.
2. Definir os Métodos HTTP:
   • Implemente os métodos GET, POST, PUT e DELETE para realizar as operações desejadas.
3. Mapear as URLs:
   • Associe as URLs aos métodos criados.
4. Processar os Dados:
   • Utilize as funções do ADVPL para manipular os dados recebidos e retornar os resultados.

3. Publicar o Serviço

1. Compilar e Publicar o Código:
   • Compile o código no Visual Studio e publique no servidor Protheus.
   • Verifique se não há erros de compilação e que o serviço está disponível.
2. Configurar o Servidor de Aplicação (AppServer):
   • Acesse o arquivo de configuração do AppServer (appserver.ini).
   • Certifique-se de que a seção [HTTP_SERVER] está configurada corretamente para permitir serviços REST.

[HTTP_SERVER]

Enabled=1

Port=8080

4. Testar o Serviço REST

1. Testar Localmente:
   • Utilize ferramentas como Postman ou cURL para testar o serviço REST.
   • Verifique se a URL configurada retorna os dados corretamente.

Exemplo de requisição no Postman:

• Método: GET
• URL: http://localhost:PORTADEFINIDA/rest/myservice

2. Validar a Integração:
   • Integre o serviço REST com a API desejada.
   • Teste a comunicação entre os sistemas e valide se os dados estão sendo trocados corretamente

Considerações Importantes

1. Segurança:

[Verificar a chave de autenticação] Implemente mecanismos de autenticação e autorização para proteger seus serviços REST.

2. Documentação:
   • Crie uma documentação clara e detalhada para os seus serviços REST, facilitando a utilização por outros desenvolvedores.
3. Performance:
   • Otimize o desempenho dos seus serviços REST para garantir uma boa experiência do usuário.
4. Erros:
   • Implemente um tratamento adequado de erros para garantir a robustez do seu serviço.
5. Padrões REST:
   • Siga os padrões REST para garantir a interoperabilidade e a escalabilidade dos seus serviços.

Como integrar o serviços REST com APIs Externas

Para integrar seus serviços REST com APIs externas, você precisará:

1. Obter as Informações da API:
   • Consulte a documentação da API para entender os métodos HTTP disponíveis, os formatos de dados e as credenciais de acesso.
2. Realizar Chamadas HTTP:
   • Utilize as funções do ADVPL para realizar chamadas HTTP para a API externa.
3. Processar os Dados:
   • Parse os dados retornados pela API e utilize-os em sua aplicação.

Recursos Adicionais

1. Documentação TOTVS:
   • Consulte a documentação oficial do TOTVS para obter mais informações sobre a criação de serviços REST no Protheus.
2. Comunidade TOTVS:
   • Participe dos fóruns e grupos da comunidade TOTVS para tirar dúvidas e compartilhar experiências.
3. Exemplos e Tutoriais:
   • Busque por exemplos e tutoriais na internet para aprender mais sobre as diferentes funcionalidades dos serviços REST no Protheus.

Conte com a Global GCS para fazer melhor aproveitamento das suas soluções TOTVS, oferecemos suporte completo e especializado. Entre em contato.