FAQs - Suporte técnico

Cross Segmento - TOTVS Backoffice (Linha Protheus) - ADVPL - O que é REST

time.pngTempo aproximado para leitura: 00:05:00 min

Dúvida

O que é, pra que serve e como funciona a comunicação em uma web API RESTful?

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

Solução
REST
(Representational State Transfer) é um estilo de arquitetura de software que define um conjunto de restrições/regras a serem usados para a criação de serviços web.

Pra que serve?
Inicialmente quando escrevemos nossas aplicações elas estão isoladas, contudo, para que seja possível consumi-las em outras aplicações é necessário expô-las por algum método de comunicação.

Dentre diversos outros métodos, o REST (RESTful API) é um deles.

Exemplo
Tenho um aplicativo mobile que registra a quantidade de estoque de cada produto.
Preciso acessar as informações do estado de estoque corrente (entradas, bloqueios e saídas), assim como enviar os dados das coletas e operações realizadas diariamente.
Estas informações precisam estar disponíveis no meu smartphone, assim como no sistema de gerenciamento da empresa.
A partir dessa necessidade, eu crio uma API RESTful e programo meu software de gerenciamento e meu smartphone para fazerem solicitações para esse serviço.
Desta forma, eu tenho um serviço único, que é consumido da mesma maneira e que mantém as informações disponíveis para diversas aplicações.

Comunicação
Na grande maioria dos casos, as comunicações RESTful ocorrem sob o protocolo HTTP utilizando o padrão JSON (JavaScript Object Notation), onde são utilizados métodos HTTP (GET, POST, PUT, DELETE e outros).

Exemplo
Preciso que seja possível visualizar os dados de um cliente com código, nome, tipo e endereço, como os dados poderão serão trazidos?
Eu irei realizar um consumo para um serviço já criado através da URI (Uniform Resource Identifier) abaixo no método GET:

{method} {schema}://{domain}/{patch}?{query}
{GET} {https}://{mydomain.com.br}/{rest/customer}?{id=CLT008}

E quando eu fizer a requisição, me será retornado o JSON abaixo:

{
"code": CLT018",
"name": "IMPACTART DIGITAL",
"strategicCustomerType": "F",
"address": {
"address": "AVENIDA ALVES CARMO, 7811",
"stateId": "SP",
"city": "JARDIM CARLOS MENDES"
}
}


O que fazer com o JSON?

Uma vez recebida a resposta da web API, realize a conversão da string para um objeto JSON e extraia os valores desejados para integrar ao seu sistema:

Exemplo em ADVPL

/** RESTANTE DA APLICAÇÃO **/

cJSON := "JSON_RESPOSTA_DO_WS_REST_AQUI"
oJSON := JSONObject():New()

// AQUI CONTÉM TODOS OS CAMPOS E CONTEÚDOS
// (ex: oJSON["code"] => "CLT018" | oJSON["address"]["stateId"] => "SP")
oJSON:FromJSON(cJSON)

/** RESTANTE DA APLICAÇÃO **/

 
Saiba mais
REST ADVPL
REST - Wikipedia
JSON - Wikipedia
URI - Wikipedia

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 _