Usina BRAdvPL Guia
Entrar
← Todos os tópicos
GUIA PRÁTICOEm revisão

Autenticação, headers e códigos HTTP no REST

Separa credenciais, autorização, transporte e resposta no REST do Protheus.

Autenticação, headers e códigos HTTP no RESTAdvPL
01 · VISÃO GERAL

Visão geral

Primeiro identifique a implementação: REST AdvPL/2.0 e tlppCore não têm configuração de autenticação intercambiável. O fluxo Protheus documenta Basic e Bearer. Basic codifica credenciais em Base64, sem cifrá-las; use HTTPS. No fluxo JWT, access_token é enviado em Authorization: Bearer; refresh_token serve ao fluxo de renovação e não substitui o token de acesso. Leia expires_in da resposta, sem fixar uma duração universal. A TOTVS informa autenticação obrigatória a partir do release 12.1.2410: não reutilize recomendações antigas de desativação de Security. Não coloque credenciais em URL, código versionado ou logs. (TOTVS, s.d., refs. 1–4) Interprete 401 como necessidade de autenticação válida e 403 como recusa de atendimento; 404 indica recurso não encontrado e 500 erro no servidor. Uma resposta HTTP 200 não substitui a validação do resultado de negócio no corpo. O exemplo é uma representação HTTP com domínio, rota e token fictícios; não é uma chamada a um endpoint real nem uma receita de configuração. (IETF, 2022, ref. 5)

Retorno

Não há retorno único: trata-se de um roteiro composto.

03 · EXEMPLO PRÁTICO

Exemplo comentado

GET /rest/test-resource HTTP/1.1
Host: api.example.invalid
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Resultado esperado

Nenhuma requisição foi executada. Substituir rota pelo recurso contratado e obter o token pelo fluxo suportado, sem publicá-lo. Tratar status e corpo separadamente. Em revisão: exemplo editorial não compilado nem executado em Protheus. Conferir includes, release, RDD e contexto antes de homologar.

BOAS PRÁTICAS
  • Guardar segredos em mecanismo apropriado ao ambiente, restringir permissões e renovar tokens conforme contrato. Redigir logs sem Authorization, senha ou refresh_token; testar token ausente, expirado e usuário sem acesso em homologação.
  • Em revisão: exemplo editorial não compilado nem executado em Protheus. Conferir includes, release, RDD e contexto antes de homologar.

Conteúdos relacionados

REFERÊNCIAS
  1. TOTVS. Entendendo as novidades do REST. TDN. Consulta em 2026-10-26.
  2. TOTVS. Fluxo básico de autenticação Rest no Protheus. Central de Atendimento. Consulta em 2026-10-26.
  3. TOTVS. Requisição para Token JWT Rest. Central de Atendimento. Consulta em 2026-10-26.
  4. TOTVS. WebService: Authentication / User not authorized. Central de Atendimento. Consulta em 2026-10-26.
  5. IETF. RFC 9110: HTTP Semantics, 2022, seção 15. Consulta em 2026-10-26.
Situação
Em revisão
Página criada em
Última revisão em
Idioma original
Português
Revisão
Usina.BR
0 comentário(s) aprovado(s)

Comentários

Ainda não há comentários aprovados.

Entre com Google ou Microsoft para comentar.

Powered by Usina Docs · Alpha