CONTEÚDO
- Visão Geral
- Configurações INI
- Verbos
- Atributos de Resposta
01. VISÃO GERAL
A API de primeiro acesso do portal do beneficiário tem como objetivo gerar um login e senha iniciais para novos beneficiários, enviando essas credenciais via email.
- Para o funcionamento da api é necessário que os parâmetros de envio de email estejam configurados
MV_RELAUTH - Se o servidor de e-mail requer autenticação
MV_RELSERV - Nome do servidor de envio de e-mail
MV_RELACNT - Conta utilizada no envio de e-mail
MV_RELPSW - Senha da conta de e-mail
MV_RELSSL - Informe se o servidor de SMTP possui conexão do tipo segura ( SSL/TLS )
MV_RELTLS - Informe se o servidor de SMTP possui conexão do tipo segura ( SSL/TLS )
MV_PORSMTP - Porta do servidor SMTP
MV_RELAUSR - Usuário para autenticação no servidor
MV_RELTIME - TimeOut no envio de e-mail
- É necessário que os parâmetros de integração com o mingle estejam configurados.
MV_MINGURL - Indica a URL do Mingle
MV_MINGIUS - Login do Usuário Integrador no Mingle para requisição
MV_MINGTOK - Token de Autenticação no Mingle para Requisição
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 | Atributo (body) |
---|---|---|
POST | https://<url>:porta>/rest/totvsHealthPlans/v1/BenefFirstAccess | cpf |
04. ATRIBUTOS DE RESPOSTA
JSON de resposta.
Atributo | Campo Protheus |
---|---|
code | codigo de retorno da requição rest ( exemplo : 200, 400 ) |
message | mensagem referente ao codigo da requisição ( exemplo: bad request, success) |
detailedMessage | irá mostra detalhadamente a mensagem de retorno em caso de sucesso e de erro . |