Versões comparadas

Version Versão antiga 1 Nova versão 2
Alterações feitas por

Bruno Vieira (Unlicensed)

Bruno Vieira (Unlicensed)

Gravado em

Chave

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

Tópicos:

Índice

URL Base

AmbientesURL
Homologação

https://

exemplo

ms3.tapcore.com.br/mssuite/

Produção

https://

exemplo

ms3.tapcore.com.br/mssuite/


Endpoint


EndpointMétodoDescrição

reembolso/inserir

POST

Descrição do método POST.


Parâmetros

ParâmetroObrigatórioTipoDescrição
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


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




Bloco de código
true
languagejs
themeMidnight
titleRetorno API falha
linenumberscollapsetrue
{
    "protocolo": "3139042017080113117" ,
    "id_operadora": "71",
    "mshash": "NjA1ZDhkNjkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==",
    "matricula_titular": "30000309100060",
    "matricula_beneficiario": "30000309100060",
    "cpf_titular": "04253582753",
    "telefone": "",
    "nome_titular": "",
    "operadora_ans": "",
    "despesas":
    [{
        "utilizador_matricula": "123",
        "utilizador_nome": "",
        "id_tipo_reembolso": "",
        "prestador_documento": "",
        "data_despesa": "2016-11-20",
        "valor_despsa": "200.40",
        "arquivos": [{
            "url": "http://mobilesaude.com.br/files/teste.txt",
            "nome": "teste.txt"
        },
        {
            "url": "http://mobilesaude.com.br/files/teste.txt",
            "nome": "teste.txt"
        }]
    },
    {
        "utilizado_matricula": "123",
        "utilizador_nome": "",
        "id_tipo_reembolso": "",
        "prestador_documento": "",
        "data_despesa": "2016-11-20",
        "valor_despsa": "200.40",
        "arquivos": [],
        "url": "http://mobilesaude.com.br/files/teste.txt",
        "nome": "teste.txt",
        "diretorio": "reembolsos"
    }]
}

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
collapsetrue
{
    "protocolo" : "3139042017080113117" ,
    "mshash" : "NjA1ZDhkNjkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
    "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)

Bloco de código
collapse
languagejs
themeMidnight
titleRetorno API sucesso
linenumberstruetrue
{
    "protocolo" : "3139042017080113117" ,
    "mshash" : "NjA1ZDhkNjkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
    "status" : "2"
}
5-

Exemplo de retorno

API

(Erro)

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
Notacode
languagejs
themeMidnight
titleATENÇÃO
Retorno API sucesso
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"
}