Versões comparadas
Chave
- Esta linha foi adicionada.
- Esta linha foi removida.
- A formatação mudou.
Tópicos:
Índice |
---|
URL Base
Ambientes | URL |
---|---|
Homologação | https://ms3.tapcore.com.br/mssuite/ |
Produção | https://ms3.tapcore.com.br/mssuite/ |
Endpoint
Endpoint | Método | Descrição |
---|---|---|
formulario/submit_formulario | PUT | Responsável por inserir uma nova solicitação de cancelamento de plano para análise, o beneficiário envia seus dados pessoais, correções e alterações de seu cadastro e arquivos de comprovante. |
Como configurar a URL de callback
Acesse o seu painel administrativo em: painel.tapcore.com.br, no menu lateral busque a funcionalidade: Beneficiário > Cancelamento de plano> Configuração
Preencha o campo: URL de Callback com a URL que receberá a requisição de callback após inserção de uma nova solicitação de cancelamento de plano.
Segurança das URLs
Informações | ||
---|---|---|
| ||
Todas as imagens que estão sob nosso domínio não são disponibilizadas de forma pública, favor seguir as recomendações abaixo! |
Por questões de segurança todas as imagens ou objetos disponíveis através de uma URL serão enviadas com uma assinatura, desta forma, o download dos objetos ou imagens disponíveis, só serão possíveis por um período de aproximadamente 15 minutos.
Recomenda-se que seja feito o download da imagem ou objeto assinado assim que receber este payload e não salve a URL pois ela ficará indisponível após o tempo pré-determinado.
Em casos que seja necessário o acesso a este objeto ou imagem depois desse período, re-envie o callback através do painel para receber uma nova assinatura válida por mais 15 minutos
Exemplo da url ->https://autorizacao.s3-sa-east-1.amazonaws.com/AWSAccessKeyId=ABC&Expires=1616095118&Signature=ABCD
Especificação do Callback do Cancelamento de plano
Uma particularidade do formulário de cancelamento de plano é que ele é dinamicamente configurável, por esse motivo os dados enviados que serão documentados abaixo poderão variar de acordo com o estado atual do seu formulário, mas o padrão se matem.
O callback será feito através de uma requisição HTTP do tipo POST ao serviço cadastrado, os parâmetros serão enviados via RAW no formato JSON, conforme as especificações abaixo:
Atributos que podem gerar dúvidas
Parâmetro | Obrigatório | Tipo | Descrição | |||||||
---|---|---|---|---|---|---|---|---|---|---|
id_motivo_solic_cancelamento | true |
| Conforme cadastro dos motivos de cancelamento, configurados pelo cliente no painel de administração (CMS). | |||||||
id_operadora | true |
| Id da operadora para a qual serão buscados os grupos de menu. | |||||||
mshash | true |
| HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. | |||||||
id_status_cancelamento | false |
| Status do cancelamento, conforme regra: 1 - Solicitado; 2 - Em processamento; 3 - Concluído |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "id_solicitacao_cancelamento":"48", "id_protocolo":"1228", "id_operadora":"16", "id_motivo_solic_cancelamento":"3", "id_status_cancelamento":"1", "matricula_titular":"00010061003247003", "nome_titular":"NOME DO BENEFICIARIO DE EXEMPLO", "cpf_titular":"94243280010", "telefone_titular":"02733410188", "email_titular":"teste@emaildobeneficiario.com.br", "patrocinadora_titular":"", "descricao":"", "texto_complementar":"LOREM IPSUM", "data_solicitacao":"2020-11-14 09:28:30", "protocolo":"20171114500003", "mshash":"ZDhkNjY0MDY3NTgwMTg0Y2I4ZWE3ZmZiZGEyNDM0NmMwZDI0YmQwYw==", "beneficiarios":[ { "nome":"NOME DO BENEFICIARIO DE EXEMPLO", "matricula":"90909090909090909", "parentesco":"Titular", "data_nascimento":"1978-08-01", "convenio_segmentacao":"AMBULATORIAL + HOSPITALAR COM OBSTETRICIA + ODONTOLOGICO", "numero_contrato":"00010061000000000002001000000011001", "texto_complementar":null, "data_inclusao":"2020-04-01", "convenio_ans":"1001" }, { "nome":"NOME DO BENEFICIARIO DEPENDENTE DE EXEMPLO", "matricula":"90909090909090909222", "parentesco":"Dependente", "data_nascimento":"1978-08-01", "convenio_segmentacao":"AMBULATORIAL + HOSPITALAR COM OBSTETRICIA + ODONTOLOGICO", "numero_contrato":"00010061000000000002001000000011001", "texto_complementar":null, "data_inclusao":"2020-04-01", "convenio_ans":"1001" } ], "status":"Solicitado", "motivo":"Reajuste no valor do plano" } |
2- Retornos de sucesso Callback Cancelamento de plano
Todo callback executado, que tenha como retorno status header 200 será considerado uma conexão de sucesso, independente do seu retorno.
É possível também alterar o status da solicitação de cancelamento de plano, basta que o serviço de integração retorne em seu body um JSON no padrão abaixo.
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "protocolo" : "3139042017080113117" , "mshash" : "NjA1ZDhkNjkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" , "status" : "2" } |
Pesquisa em tempo real |
---|