Skip to content

mateustoin/Health-Prevent-Technology-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Linkedin Badge Linkedin Badge Linkedin Badge Linkedin Badge

Comunicação como chave para promoção da saúde preventiva.

Introdução

Repositório de uma API desenvolvida para o backend da Health Prevent Technology. O objetivo da API é facilitar a integração da tecnologia de envio de sms's e mensagens de voz que já existem em grandes operadoras de plano de saúde, mas não tem em planos pequenos e médios.

Esta API se conecta com um banco de dados PostgreSQL onde são armazenados os dados necessários apenas para notificar os clientes da operadora através de mensagens, após terem confirmado a vontade de recebê-los.

Para as notificações com mensagens de sms e voz foi utilizada a API do Zenvia Total Voice.

Endpoints

Existem dois tipos de Endpoints: para consulta de dados, com requisições do tipo get e envio de mensagems de texto (sms) e voz (tts), com requisições do tipo post.

Consulta de dados (requisições GET)

/

Redireciona a API para a página de documentação.

/clients

Exibe todos os clientes cadastrados pela operadora de plano de saúde para envio das mensagens.

/clients/disease/{type_disease}

Retorna lista de clientes cadastrados pela operadora de plano de saúde, a partir do tipo de condição clínica.

/clients/age/{min}/{max}

Retorna lista de clientes cadastrados pela operadora de plano de saúde, a partir do intervalo de idade definido.

Envio de mensagens (requisições POST)

O envio de mensages requer um body (JSON) que será responsável por informar sobre qual público a mensagem será enviada (por condição clínica ou idade), o nome da operadora de Plano de Saúde que está enviando e a mensagem propriamente dita. Seguindo o padrão a seguir:

{
    eventName: string,
    minAge: integer,
    maxAge: integer,
    clinicalCOndition: string,
    message: string,
    company: string
}

/notification/sms/disease

Envia mensagem de sms para os clientes da operadora de plano de saúde filtrados pela condição clínica selecionada.

/notification/sms/age

Envia mensagem de sms para os clientes da operadora de plano de saúde filtrados pela idade.

/notification/tts/disease

Envia mensagem de voz para os clientes da operadora de plano de saúde filtrados pela condição clínica selecionada.

/notification/tts/age

Envia mensagem de voz para os clientes da operadora de plano de saúde filtrados pela idade.

Licença

Copyright © 2020 Mateus Antonio da Silva, João Victor Galvão, Marismar da Costa Silva, Gustavo Eraldo da Silva.
This project is MIT licensed.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages