API Login

CONTEÚDO

Visão Geral
Configurações INI
Verbos
Uso da API - POST
Atributos de Resposta
Tabelas utilizadas

01. VISÃO GERAL

A API login tem como objetivo validar e retornar os dados dos beneficiarios(B49) do login(BSW) informado. O verbo disponibilizado é o POST.

02. CONFIGURAÇÕES INI

Para iniciar a instalação do processo, devemos configurar seu INI Protheus com a funcionalidade REST para habilitar o acesso as API´s. Documentos auxiliares:

03. VERBOS

Seguem os verbos disponíveis na API:

Verbo	URL	Descrição
POST	https://<url>:porta>/rest/totvsHealthPlans/v1/login	Valida o login e retorna os dados do beneficiario

04. USO DA API - POST

Dados do body de envio:

Atributo	Tipo	Regra	Descrição
login	Caracter	Obrigatório	BSW_LOGUSR
password	Caracter	Obrigatório	BSW_SENHA(A api suporta o envio de senhas com a criptografia MD5 ou sem criptografia)

05. ATRIBUTOS DE RESPOSTA

JSON de resposta.

Atributo pai	Atributo	Campo Protheus
loginDetails	code	BSW_CODUSR
	username	BSW_LOGUSR
	email	BSW_EMAIL
	name	BSW_NOMUSR
beneficiaries	subscriberId	B49_BENEFI
	name	BA1_NOMUSR
	subscriberType	BA1_TIPUSU
menus	code	AI8_CODMNU
	name	AI8_TEXTO
	main	AI8_CODPAI
	module	AI8_ROTINA

06. TABELAS UTILIZADAS

BSW - Login

B49 - Beneficiarios x Login

AI8 - Menus

Árvore de páginas