Comparação de Páginas

Tópicos:

Índice

1 - URL base API

Ambientes	URL
Homologação	https://ms3.tapcore.com.br/mssuite/
Produção	https://ms3.tapcore.com.br/mssuite/

Como configurar a URL de Callback

Acesse o seu painel administrativo em: painel.tapcore.com.br e no menu lateral busque a funcionalidade:

Beneficiário -> Nome da Feature -> 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 cartão.

2 - Segurança das URLs

Informações

title	IMPORTANTE

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

3 - Endpoints

Nota

title	ATENÇÃO

Utilize abaixo apenas o endpoint do serviço contratado, todos os serviços necessitam de auxilio/implementação da Mobile Saúde.

Atualização Cadastral

Feature	Endpoint	Método	Descrição
Atualização Cadastral	formulario/submit_formulario	PUTPOST	Responsável por inserir uma nova solicitação de atualização cadastral para análise, o beneficiário envia seus dados pessoais, correções e alterações de seu cadastro e arquivos de comprovante.

2 via de Cartão

Feature	Endpoint	Método	Descrição
2 via de Cartão	solicitacao/solicitacao_cartao	PUTPOST	Responsável por inserir uma nova solicitação de segunda via de cartão para análise, o beneficiário informa que deseja um novo cartão, motivo e forma de entrega, por fim os atendentes/colaboradores autorizam ou não a segunda via.

Reembolso

Feature	Endpoint	Método	Descrição
Reembolso	reembolso/inserir	POST	Responsável por inserir uma nova solicitação de reembolso para análise, o beneficiário informa um novo reembolso que por fim os atendentes/colaborador autorizam o reembolso ou não.

4- Parâmetros

Atualização Cadastral

Feature	Parâmetro	Obrigatório	Tipo	Descrição
Atualização Cadastral	protocolo	true	String
Atualização Cadastral	id_operadora	true	Inteiro	Id da operadora para a qual serão buscados os grupos de menu.
Atualização Cadastral	mshash	true	String	HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados.
Atualização Cadastral	tipo	false	String	Tipo de beneficiário a que as informações se referem, conforme seu grau de dependência (t =Titular, d = Dependente, a = Agregado).
Atualização Cadastral	nome	true	String
Atualização Cadastral	matricula	true	String	Matrícula do usuário que está logado.
Atualização Cadastral	matricula_titular	true	String	Matrícula do titular da conta.
Atualização Cadastral	campos	true	Array	Propriedade que enviará os campos do formulário.
Atualização Cadastral	campos.id	true	Inteiro	ID do tipo de campo que será enviado.
Atualização Cadastral	campos.label	true	String	Label da opção preenchida ou selecionada pelo usuário.
Atualização Cadastral	campos.name	true	String	Nome do campo que foi preenchido.
Atualização Cadastral	campos.value	true	String	Valor do campo preenchido pelo usuário.

Bloco de código

language	js
theme	Midnight
title	Exemplo de RAW enviado para a url de callback:
linenumbers	true
collapse	true

{
  "protocolo":" XYZ",
  "id_operadora" : 9999,
  "mshash" : "" ,
  "tipo" : "" ,
  "nome" : "Nome 1" ,
  "matricula" : "" ,
  "matricula_titular" : "999",
  "campos" :
  [
    {
      "id": "10",
      "label": "País",
      "name": "atualizacao_cadastral_pais",
      "value": "android test"
    },
    {
      "id": "5",
      "label": "Telefone residencial",
      "name": "atualizacao_cadastral_telefone_residencial",
      "value": "1212121"
    },
    {
      "id": "49",
      "label": "Número",
      "name": "atualizacao_cadastral_numero_2",
      "value": "android test"
    },
    {
      "id": "859"
      "label": "Comprovante de endere\u00e7o",
      "name": "atualizacao_cadastral_comprovante_de_endereco",
      "value": "https:\/\/atualizacao-cadastral.s3-sa-east-1.amazonaws.com\/969542b3-4ab6-4d54-9261-6196f2eaba5a.1616074616142.png?AWSAccessKeyId=AKIA34OGA4QDSSXFT3F4&Expires=1616076000&Signature=6bH3weEUx5otIY49asdxY%2BN%2Bw0%3D",    
    }
  ]
}

2 via de Cartão

Feature	Parâmetro	Obrigatório	Tipo	Descrição
2 via de Cartão	protocolo	true	String
2 via de Cartão	mshash	true	String	HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados.
2 via de Cartão	id_solicitacao_cartao	true	Int
2 via de Cartão	id_operadora	true	Inteiro	Id da operadora para a qual serão buscados os grupos de menu
2 via de Cartão	id_aplicacao	true	Inteiro
2 via de Cartão	id_status_cartao	true	Inteiro
2 via de Cartão	id_motivo_solic_cartao	true	Inteiro
2 via de Cartão	id_forma_entrega_cartao	true	Inteiro
2 via de Cartão	nome_titular	true	String
2 via de Cartão	cpf_titular	true	Inteiro
2 via de Cartão	matricula_titular	true	String
2 via de Cartão	telefone_titular	true	Inteiro
2 via de Cartão	estado_civil_titular	true	String
2 via de Cartão	email_titular	true	String
2 via de Cartão	patrocinadora_titular	false	String
2 via de Cartão	descricao	false	String
2 via de Cartão	protocolo	true	String
2 via de Cartão	data	true	String
2 via de Cartão	forma_entrega	true	String
2 via de Cartão	motivo	true	String
2 via de Cartão	arquivos	true	Array
2 via de Cartão	arquivos.id_arquivo	true	Inteiro
2 via de Cartão	arquivos.nome	true	String
2 via de Cartão	arquivos.diretorio	true	String
2 via de Cartão	arquivos.url	true	String
2 via de Cartão	arquivos.id_solicitacao_cartao	true	String
2 via de Cartão	beneficiarios	true	Array
2 via de Cartão	beneficiarios.id_beneficiario_cartao	true	Inteiro
2 via de Cartão	beneficiarios.nome	true	String
2 via de Cartão	beneficiarios.matricula	true	String
2 via de Cartão	beneficiarios.parentesco	true	String
2 via de Cartão	beneficiarios.data_nascimento	true	String
2 via de Cartão	beneficiarios.id_solicitacao_cartao	true	Inteiro
2 via de Cartão	endereco_alternativo	false	String
2 via de Cartão	status	true	String

Bloco de código

language	js
theme	Midnight
title	Exemplo de RAW enviado para a url de callback:
linenumbers	true
collapse	true

{
    "id_solicitacao_cartao": 999,
    "id_operadora": 99,
    "id_aplicacao": 7,
    "id_motivo_solic_cartao": 6,
    "id_forma_entrega_cartao": 3,
    "id_status_cartao": 1,
    "matricula_titular": "000100020003",
    "nome_titular": "Nome de teste",
    "cpf_titular": 12121166742,
    "telefone_titular": 27000666898,
    "estado_civil_titular": "Solteiro",
    "email_titular": "teste@gmail.com",
    "patrocinadora_titular": null,
    "descricao": null,
    "data": "2017-08-02 13:34:38",
    "endereco_alternativo": "",
    "protocolo" : "xyz123",
    "mshash" : "",
    "motivo": "Perda",
    "forma_entrega": "Entregar ao Titular pelos correios",
    "arquivos": [{
        "id_arquivo": 59,
        "nome": "c094be33c587e163ee702662491cd1a55ca6f854f.pdf",
        "diretorio": null,
        "url": https://s3-sa-east-1.amazonaws.com/solicitacao-cartao-ms/AWSAccessKeyId=ABC&Expires=1616095118&Signature=ABCD,
        "id_solicitacao_cartao": 117
    }],
    "beneficiarios": [{
        "id_beneficiario_cartao": 133,
        "id_solicitacao_cartao": 117,
        "nome": "Teste Romano Teste Rizzi",
        "matricula": "000100020003",
        "parentesco": "Titular",
        "data_nascimento": "1991-02-23",
    }],
    "status": "Solicitado"
}

Reembolso

Parâmetro	Obrigatório	Tipo	Descrição
id_reembolso	true	string	id do reembolso no banco de dados da mobile saude
id_operadora	true	string	id da operadora no banco de dados da mobile saude
id_status_reembolso			id status do reembolso sempre como 1 ( novo)
nome_titular			nome do titular do contrato do beneficiario
cpf_titular			cpf do titular do contrato do beneficiario
telefone			telefone do beneficiario
matricula_titular			matricula do titular do contrato.
matricula_beneficiario			matricula do beneficiario que está solicitando o reembolso
id_sistema_interno
observacao_interna
protocolo			protocolo gerado pela Mobile Saúde
mshash			MSHASH único da operadora.
operadora_ans			número da operadora na ANS
despesas		array objetos
despesas / id_despesa_reembolso			id da despesa do reembolso
despesas / utilizador_matricula			matricula beneficiario solicitante do reembolso
despesas / utilizador_nome			nome beneficiario solicitante do reembolso
despesas / data_despesa			data da consulta/exame do reembolso
despesas / prestador_documento			Numero do prestador que efetuou a consulta
despesas / valor_despesa			valor da despesa do reembolso
despesas / id_tipo_reembolso
despesas / prestador_estado			estado do prestador de serviço
despesas / prestador_cidade			cidade do prestador de serviço
despesas / observacao_interna
despesas / arquivos		array objetos
despesas / arquivos [0] / nome
despesas / arquivos [0] / diretorio
despesas / arquivos [0] / url
despesas / arquivos [1] / nome
despesas / arquivos [1] / diretorio
despesas / arquivos [1] / url
terceiro_passo		array objetos	Caso possua implementado o 3 passo
terceiro_passo / banco			numero do banco
terceiro_passo / agencia			numero agencia
terceiro_passo / conta			numero conta
terceiro_passo / nome			nome do titular da conta
terceiro_passo / cpf			CPF do titular da conta
terceiro_passo / hospital
terceiro_passo / observação
terceiro_passo / prestador			nme do prestador

Bloco de código

language	js
theme	Midnight
title	Exemplo de RAW enviado para a url de callback:
linenumbers	true
collapse	true

{
    "id_reembolso": "508923",
    "id_operadora": "9999",
    "id_status_reembolso": "1",
    "nome_titular": "BENEFICIARIO DEMONSTRACAO DA SILVA",
    "cpf_titular": "99999999999",
    "telefone": "49909090913",
    "matricula_titular": "315263333333",
    "matricula_beneficiario": "315263333333",
    "id_sistema_interno": "2544890",
    "observacao_interna": null,
    "protocolo": "999999920210531000242",
    "mshash": "LAKSJDFLKAJSDLFKJASLDKFJALKSDJFLKAJSDLKFJASLKDJF==",
    "operadora_ans": "98989-8",
    "despesas": [
        {
            "id_despesa_reembolso": "586336",
            "utilizador_matricula": "31526292",
            "utilizador_nome": "BENEFICIARIO DEMONSTRACAO DA SILVA",
            "data_despesa": "2021-05-27",
            "prestador_documento": "98989898989898",
            "valor_despesa": "199.00",
            "id_tipo_reembolso": "171",
            "prestador_estado": "PR",
            "prestador_cidade": "CURITIBA",
            "observacao_interna": null,
            "arquivos": [
                {
                    "nome": "imagem-1-temp.jpeg",
                    "diretorio": "reembolsos",
                    "url": "http://abcdefghil.jpeg"
                },
                {
                    "nome": "imagem2-temp.jpeg",
                    "diretorio": "reembolsos",
                    "url": "http://abcdefghil2.jpeg"
                }
            ]
        }
    ],
    "terceiro_passo": {
        "banco": "999",
        "agencia": "111222333",
        "conta": "555666777",
        "nome": "BENEFICIARIO DEMONSTRACAO DA SILVA",
        "cpf": "999.999.999-22",
        "hospital": "Medicos de Olhos",
        "observacao": "aos devs: referente a todos os atributos do 3o passo: estes campos podem ser modificados (3o passo) portanto nao sao obrigatorios, podendo nem mesmo existir",
        "prestador": "teste teste teste"
    }
}

5- Exemplo de retorno API (Sucesso)

Atualização Cadastral

Bloco de código

language	js
theme	Midnight
title	Retorno API sucesso
linenumbers	true
collapse	true

{
  "protocolo":" XYZ",
  "id_operadora" : 9999,
  "mshash" : "" ,
  "tipo" : "" ,
  "nome" : "Nome 1" ,
  "matricula" : "" ,
  "matricula_titular" : "999",
  "campos" :
  [
    {
      "id": "10",
      "label": "País",
      "name": "atualizacao_cadastral_pais",
      "value": "android test"
    },
    {
      "id": "5",
      "label": "Telefone residencial",
      "name": "atualizacao_cadastral_telefone_residencial",
      "value": "1212121"
    },
    {
      "id": "49",
      "label": "Número",
      "name": "atualizacao_cadastral_numero_2",
      "value": "android test"
    },
    {
      "id": "859"
      "label": "Comprovante de endere\u00e7o",
      "name": "atualizacao_cadastral_comprovante_de_endereco",
      "value": "https:\/\/atualizacao-cadastral.s3-sa-east-1.amazonaws.com\/969542b3-4ab6-4d54-9261-6196f2eaba5a.1616074616142.png?AWSAccessKeyId=AKIA34OGA4QDSSXFT3F4&Expires=1616076000&Signature=6bH3weEUx5otIY49asdxY%2BN%2Bw0%3D",    
    }
  ]
}

6- Exemplo de retorno API (Erro)

Bloco de código

language	js
theme	Midnight
title	Retorno API falha
linenumbers	true
collapse	true

{
    "error": "Erro: Cliente não encontrado.",
    "code": 0,
    "status": false
}

Nota

title	ATENÇÃO

Esse endpoint não possui retorno de erro mesmo enviando dados inválidos ele retorna como se não tivesse registro.Padrões documentação API

Versões comparadas

Versão antiga 4

Nova versão 5

Chave

1 - URL base API

Como configurar a URL de Callback

2 - Segurança das URLs

3 - Endpoints

Atualização Cadastral

2 via de Cartão

Reembolso

4- Parâmetros

Atualização Cadastral

2 via de Cartão

Reembolso

5- Exemplo de retorno API (Sucesso)

Atualização Cadastral

6- Exemplo de retorno API (Erro)