Versões comparadas

Version Versão antiga 12 Nova versão Atual
Alterações feitas por

Geovane Henrique Pinto da Costa

Ranniêr Reis

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Tópicos:

Índice

URL Base

AmbientesURL
Homologação

https://ms3.tapcore.com.br/mssuite/

Produção

https://ms3.tapcore.com.br/mssuite/

Endpoint

EndpointMétodoDescrição

reembolso/inserir

POST

Descrição do método POST.

Status do Reembolso

IDDescrição
1

Solicitado

2

Aprovado

3Recusado
4Em Análise
5Parcialmente Aprovado
6Pago
19Cancelado

Segurança das URLs


Informações
titleImportante

(aviso)    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 

Parâmetros

Informações

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:

Parâmetro


Bloco de código
Obrigatório
language
Tipo
js
Descrição
Cor do plano de fundo
color#EDEEF1
idtipo
String

HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados.

matricula_titulartrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
matricula_beneficiariotrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
cpf_titulartrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
telefonefalse
Cor do plano de fundo
color#EDEEF1
idtipo
String
nome_titularfalse
Cor do plano de fundo
color#EDEEF1
idtipo
String
operadora_ansfalse
Cor do plano de fundo
color#EDEEF1
idtipo
String
despesastrue
Cor do plano de fundo
color#EDEEF1
idtipo
Array
despesas.utilizador_matriculatrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
despesas.utilizador_nometrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
despesas.id_tipo_reembolsotrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
despesas.prestador_documentotrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
despesas.data_despesatrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
despesas.valor_despsatrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
despesas.arquivostrue
Cor do plano de fundo
color#EDEEF1
idtipo
Array
despesas.arquivos.urltrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
despesas.arquivos.nometrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
utilizado_matriculatrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
utilizador_nometrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
utilizador_nometrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
id_tipo_reembolsotrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
prestador_documentotrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
data_despesatrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
valor_despsatrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
arquivostrue
Cor do plano de fundo
color#EDEEF1
idtipo
Array
arquivos.urltrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
arquivos.nometrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
urltrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
nometrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
diretoriotrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
{ "protocolo": "31390420132237080113117"
Bloco de código
languagejs
themeMidnight
linenumberstrue
theme
protocolotrue
Cor do plano de fundo
color#EDEEF1
Inteiro
id_operadoratrue
Cor do plano de fundo
color#EDEEF1
Inteiro

Id da operadora para a qual serão buscados os grupos de menu

mshash

true

Midnight
linenumberstrue
{
    "id_reembolso": "508923",
    "id_operadora": "9999",
    "id_status_reembolso": "1",
    "nome_titular": "BENEFICIARIO DEMONSTRACAO DA SILVA",
    "idcpf_operadoratitular": "72199999999999",
    "mshashtelefone": "NjA1ZDhjkskkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==49909090913",
    "matricula_titular": "32323309100060315263333333",
    "matricula_beneficiario": "33320309100060315263333333",
    "cpfid_sistema_titularinterno": "2544890",
    "11122233396"observacao_interna": null,
    "telefoneprotocolo": "999999920210531000242",
    "nome_titularmshash": "LAKSJDFLKAJSDLFKJASLDKFJALKSDJFLKAJSDLKFJASLKDJF==",
    "operadora_ans": "98989-8",
    "despesas": [
   [{     {
            "id_despesa_reembolso": "586336",
            "utilizador_matricula": "32131526292",
            "utilizador_nome": "BENEFICIARIO DEMONSTRACAO DA SILVA",
            "iddata_tipo_reembolsodespesa": "2021-05-27",
            "prestador_documento": "98989898989898",
            "datavalor_despesa": "2016-11-20199.00",
            "valorid_tipo_despsareembolso": "200.40171",
         "arquivos   "prestador_estado": [{"PR",
            "urlprestador_cidade": "https://reembolso.s3-sa-east-1.amazonaws.com/AWSAccessKeyId=ABC&Expires=1616095118&Signature=ABCDCURITIBA",
            "nomeobservacao_interna": null,
            "teste.txtarquivos": [
       },         {
                    "urlnome": "https://reembolso.s3-sa-east-1.amazonaws.com/AWSAccessKeyId=ABC&Expires=1616095118&Signature=ABCD",imagem-1-temp.jpeg",
                    "diretorio": "nome"reembolsos",
                    "url": "teste.txt"http://abcdefghil.jpeg"
           }]     },
                {
                    "utilizado_matriculanome": "321imagem2-temp.jpeg",
                 "utilizador_nome   "diretorio": "reembolsos",
                    "id_tipo_reembolsourl": "http://abcdefghil2.jpeg"
                }
            ]
        }
    ],
    "terceiro_passo": {
        "prestador_documentobanco": "999",
        "data_despesaagencia": "2016-11-20111222333",
        "valor_despsaconta": "200.40555666777",
        "arquivosnome": [] "BENEFICIARIO DEMONSTRACAO DA SILVA",
        "urlcpf": "https://reembolso.s3-sa-east-1.amazonaws.com/AWSAccessKeyId=ABC&Expires=1616095118&Signature=ABCD999.999.999-22",
        "hospital": "Medicos de Olhos",
        "nomeobservacao": "teste.txtaos devs: referente a todos os atributos do 3o passo: estes campos podem ser modificados (3o passo) portanto nao sao obrigatorios, podendo nem mesmo existir",
        "diretorioprestador": "reembolsosteste teste teste"
    }]
}

Retorno com Alteração de Valores

Bloco de código
languagejs
themeMidnight
titleOs valores devem ser atribuidos por despesas como no padrão abaixo
linenumberstrue
{
    "protocolo" : "31390420170801133212" ,
    "mshash" : "NjA1ZDhkNjkzN2RjMz213bNTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
    "despesas" : [{
        "id_status_reembolso" : "" ,
        "id_despesa_reembolso" : "" ,
        "valor_glosado" : 99.99,
        "valor_uso_indevido" : 99.99,
        "valor_coparticipacao" : 99.99 ,
        "valor_reembolsado" : 99.99 ,
        "observacao" : "Teste observacao"
    }]
}

Exemplo de retorno API (Sucesso)

Obs: As informações enviadas pelo Callback a Api gravará e devolverá um retorno como o exemplo abaixo, mas devemos dar atenção ao atributo "status", caso tenha intenção de atualizar o status do reembolso no CMS sem a intervenção direta, devemos informar o codigo do "status" do reembolso no retorno e a rotina de callback irá disparar um recurso para executar essa mudança. Portanto, caso exista um fluxo de aprovação manual da operadora e não terá o recurso de atualização direta, não será necessário o retorno abaixo.

Os status de reembolso estão no inicio deste documento.

Bloco de código
languagejs
themeMidnight
linenumberstrue
{
    "protocolo" : "3139042017080113117" ,
    "mshash" : "NjA1ZDhkNjkzN2RjMz213bNTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
    "status" : "2"
}

Exemplo de retorno (Erro)

Bloco de código
languagejs
themeMidnight
linenumberstrue
{
    "status": false,
    "data": [],
    "critical": [
        {
            "COD": 0,
            "DESC": "Atributo [prestador_documento] é obrigatório para inserção de uma despesa",
            "origem": "/mssuite/plataforma_beneficiario/reembolso_online/v2/api/reembolso/inserir",
            "trace": "#0 /var/www/html/mssuite/plataforma_beneficiario/reembolso_online/v2/application/libraries/entity/DespesaEntity.php(86): DespesaEntity->verificaAtributo('prestador_docum...'),#1 /var/www/html/mssuite/plataforma_beneficiario/reembolso_online/v2/application/controllers/api/Reembolso.php(361): DespesaEntity->verificarIntegridadeDespesa(Object(ConfiguracaoEntity)),#2 /var/www/html/mssuite/shared/library/ci/3.1.0/system/core/CodeIgniter.php(514): Reembolso->inserir(),#3 /var/www/html/mssuite/plataforma_beneficiario/reembolso_online/v2/index.php(293): require_once('/var/www/html/m...'),#4 {main}",
            "SOLU": null,
            "REAL": null,
            "CONT": null
        }
    ],
    "timestamp": "2019-04-22T11:58:36-03:00",
    "msg": "Atributo [prestador_documento] é obrigatório para inserção de uma despesa"
}