Tópicos:
Índice
URL Base
| Ambientes | URL |
|---|---|
| Homologação | |
| Produção |
Endpoint
| Endpoint | Método | Descrição |
|---|---|---|
reembolso/inserir | POST | Descrição do método POST. |
Status do Reembolso
| ID | Descrição |
|---|---|
| 1 | Solicitado |
| 2 | Aprovado |
| 3 | Recusado |
| 4 | Em Análise |
| 5 | Parcialmente Aprovado |
| 6 | Pago |
| 19 | Cancelado |
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
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 | Obrigatório | Tipo | Descrição | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
| protocolo | true |
| ||||||||
| 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. | |||||||
| matricula_titular | true |
| ||||||||
| matricula_beneficiario | true |
| ||||||||
| cpf_titular | true |
| ||||||||
| telefone | false |
| ||||||||
| nome_titular | false |
| ||||||||
| operadora_ans | false |
| ||||||||
| despesas | true |
| ||||||||
| despesas.utilizador_matricula | true |
| ||||||||
| despesas.utilizador_nome | true |
| ||||||||
| despesas.id_tipo_reembolso | true |
| ||||||||
| despesas.prestador_documento | true |
| ||||||||
| despesas.data_despesa | true |
| ||||||||
| despesas.valor_despsa | true |
| ||||||||
| despesas.arquivos | true |
| ||||||||
| despesas.arquivos.url | true |
| ||||||||
| despesas.arquivos.nome | true |
| ||||||||
| utilizado_matricula | true |
| ||||||||
| utilizador_nome | true |
| ||||||||
| utilizador_nome | true |
| ||||||||
| id_tipo_reembolso | true |
| ||||||||
| prestador_documento | true |
| ||||||||
| data_despesa | true |
| ||||||||
| valor_despsa | true |
| ||||||||
| arquivos | true |
| ||||||||
| arquivos.url | true |
| ||||||||
| arquivos.nome | true |
| ||||||||
| url | true |
| ||||||||
| nome | true |
| ||||||||
| diretorio | true |
|
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"protocolo": "31390420132237080113117" ,
"id_operadora": "721",
"mshash": "NjA1ZDhjkskkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==",
"matricula_titular": "32323309100060",
"matricula_beneficiario": "33320309100060",
"cpf_titular": "11122233396",
"telefone": "",
"nome_titular": "",
"operadora_ans": "",
"despesas":
[{
"utilizador_matricula": "321",
"utilizador_nome": "",
"id_tipo_reembolso": "",
"prestador_documento": "",
"data_despesa": "2016-11-20",
"valor_despsa": "200.40",
"arquivos": [{
"url": "https://reembolso.s3-sa-east-1.amazonaws.com/AWSAccessKeyId=ABC&Expires=1616095118&Signature=ABCD",
"nome": "teste.txt"
},
{
"url": "https://reembolso.s3-sa-east-1.amazonaws.com/AWSAccessKeyId=ABC&Expires=1616095118&Signature=ABCD",
"nome": "teste.txt"
}]
},
{
"utilizado_matricula": "321",
"utilizador_nome": "",
"id_tipo_reembolso": "",
"prestador_documento": "",
"data_despesa": "2016-11-20",
"valor_despsa": "200.40",
"arquivos": [],
"url": "https://reembolso.s3-sa-east-1.amazonaws.com/AWSAccessKeyId=ABC&Expires=1616095118&Signature=ABCD",
"nome": "teste.txt",
"diretorio": "reembolsos"
}]
} |
Retorno com Alteração de Valores
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"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 | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"protocolo" : "3139042017080113117" ,
"mshash" : "NjA1ZDhkNjkzN2RjMz213bNTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
"status" : "2"
} |
Exemplo de retorno (Erro)
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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"
} |