Versões comparadas

Versão antiga 8

changes.mady.by.user Ranniêr Reis

Gravado em

comparado com

Nova versão 9

changes.mady.by.user Ranniêr Reis

Gravado em

Chave

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

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/

2- Endpoints

Atualização Cadastral - endpoint

Feature

Endpoint

Método

Descrição

Listagem status de solicitação atualização cadastral

/atualizacao_cadastral/api/v1/ws/formulario/get_all_status

GET

Retorna os tipos de status de Solicitações de Autorizações.

Feature

Endpoint

Método

Descrição

Detalhes do protocolo de atualização cadastral

/atualizacao_cadastral/api/v1/ws/formulario/get_protocolo

GET

Retorna o status do protocolo requerido.

Feature

Endpoint

Método

Descrição

Atualização status protocolo de atualização cadastral

/atualizacao_cadastral/api/v1/ws/formulario/atualiza_status_protocolo

POST

Atualiza o status de um protocolo de atualização cadastral iniciado.

2 via de cartão

1.1 - Segurança da informação

Nota
titleATENÇÃO

É importante frizar que a Mobile Saúde está implementando novas políticas de segurança, estamos implementando um novo sistema de Firewall (WAF) para bloqueios que identificarmos como nocivos, onde iremos fortemente atuar em:

  • Requisições que não sejam consideradas válidas;
  • Requisições identificadas como instruções de SQL Injection;

Recomendamos fortemente a tratativa de: Mensagens de erro não tratadas (as famosas excepctions), pois o envio de muitas destas requisições ocasionará que o seu serviço de callback seja paralizado.

Nos casos em que identificamos como tentativas nocivas aos serviçõs da Mobile Saúde repetidamente, iremos adotar o BLOQUEIO do ip de origem e com isso os serviços da operadora podem ser paralizados, em casos de falso positivo entre imediatamente em contato com o setor de Atendimento da Mobile Saúde, pelo nosso chat ou telefone para contato.


2- Endpoints

Atualização Cadastral - endpoint

Feature

Endpoint

Método

Descrição

Listagem status de

segunda via de cartão

solicitação atualização cadastral

/

solicitacao

atualizacao_

cartao

cadastral/api/v1/ws/

api

formulario/get_all_status

/listar

GET

Lista completa

Retorna os tipos de status de

solicitação do cartão

Solicitações de Autorizações.


Feature

Endpoint

Método

Descrição

Listagem de solicitacões de segunda via de cartão

Detalhes do protocolo de atualização cadastral

/

solicitacao

atualizacao_

cartao

cadastral/api/v1/

api

ws/

motivoSolicitacao

formulario/

listar

get_protocolo

GET

Lista de motivos de solicitação de segunda via e cartão cadastradas no painel

Retorna o status do protocolo requerido.


Feature

Endpoint

Método

Descrição

Detalhes de segunda via der cartão

Atualização status protocolo de atualização cadastral

/atualizacao_cadastral/api/v1/ws/formulario/

carregar

GET

Detalhes de uma solicitação de cartão

atualiza_status_protocolo

POST

Atualiza o status de um protocolo de atualização cadastral iniciado.

2 via de cartão - endpoint

Feature

Endpoint

Método

Descrição

Listagem

formas

status de

entregas

segunda via de cartão

/solicitacao_cartao/v1/api/

formaEntrega

status/listar

GET

Lista

formas

completa de status de

entrega

solicitação do cartão

cadastrado, ex: buscar no correios, local de trabalho, casa, etc...


Feature

Endpoint

Método

Descrição

Atualização status protocolo

Listagem de solicitacões de segunda via de cartão

/solicitacao_cartao/v1/api/

solicitacao

motivoSolicitacao/

atualizarStatus

listar

POST

Atualização dos protocolos solicitados pelos beneficiários na base da Mobile Saúde.

Reembolso - endpoint

GET

Lista de motivos de solicitação de segunda via e cartão cadastradas no painel


Feature

Endpoint

Método

Descrição

Listagem status solicitação de reembolso

Detalhes de segunda via der cartão

/

plataforma

atualizacao_

beneficiario

cadastral/

reembolso_online

api/v1/

api

ws/

status

formulario/

listar

carregar

GET

Listagem com os status de Reembolso solicitados.

Detalhes de uma solicitação de cartão


Feature

Endpoint

Método

Descrição

Listagem

tipos

formas de

solicitação

entregas segunda via de

reembolso

cartão

/

plataforma_beneficiario/reembolso_online

solicitacao_cartao/v1/api/

tipoReembolso

formaEntrega/listar

GET

Listagem com os tipos de Reembolso cadastrados

Lista formas de entrega do cartão cadastrado, ex: buscar no correios, local de trabalho, casa, etc...


Feature

Endpoint

Método

Descrição

Detalhes de uma solicitação de reembolso

Atualização status protocolo de segunda via de cartão

/

plataforma_beneficiario/reembolso_online

solicitacao_cartao/v1/api/

reembolso

solicitacao/

detalhes

atualizarStatus

GET

Listagem com os detalhes de um pedido de reembolso.

POST

Atualização dos protocolos solicitados pelos beneficiários na base da Mobile Saúde.

Reembolso - endpoint

Feature

Endpoint

Método

Descrição

Atualizar protocolo de

Listagem status solicitação de reembolso

/plataforma_beneficiario/reembolso_online/v1/api/

reembolso

status/

atualizar

listar

POST

Atualizar pedido de reembolso realizado

GET

Listagem com os status de Reembolso solicitados.


Feature

Endpoint

Método

Descrição

Atualizar usuário atribuído na análise

Listagem tipos de solicitação de reembolso

/plataforma_beneficiario/reembolso_online/v1/api/

reembolso

tipoReembolso/

atualizar

listar

POST

Atualizar usuário atribuído ao pedido de reembolso realizado.

Cancelamento de plano - endpoint

GET

Listagem com os tipos de Reembolso cadastrados.


Feature

Endpoint

Método

Descrição

Listagem status cancelamento de plano

Detalhes de uma solicitação de reembolso

/

cancelamento

plataforma_

plano

beneficiario/

api

reembolso_online/v1/

ws

api/

formulario/get_all_status

reembolso/detalhes

GET

Retorna

Listagem com os

tipos

detalhes de

status de cancelamento de plano

um pedido de reembolso.


Feature

Endpoint

Método

Descrição

Detalhes

Atualizar protocolo de

uma

solicitação de

cancelamento de plano

reembolso

/

cancelamento

plataforma_

plano

beneficiario/

api

reembolso_online/v1/

ws

api/

formulario

reembolso/

get_protocolo

atualizar

GETRetorna os detalhes do protocolo requerido

POST

Atualizar pedido de reembolso realizado.


Feature

Endpoint

Método

Descrição

Atualizar

protocolo de solicitação de cancelamento de plano

usuário atribuído na análise de reembolso

/

cancelamento

plataforma_

plano

beneficiario/

api

reembolso_online/v1/

ws

api/

formulario/atualiza_status_protocolo

reembolso/atualizar

POST

Atualiza o status de um protocolo de cancelamento de plano solicitado.

Solicitação de autorização

Atualizar usuário atribuído ao pedido de reembolso realizado.

Cancelamento de plano - endpoint

Feature

Endpoint

Método

Descrição

Listagem status

solicitação

cancelamento de

autorização

plano

/

solicitacao

cancelamento_

autorizacoes

plano/api/v1/ws/formulario/get_all_status

GET

Retorna os tipos de status de

Solicitações

cancelamento de

Autorizações

plano.


Feature

Endpoint

Método

Descrição

Detalhes de uma solicitação de cancelamento de

autorização

plano

/
solicitacao
cancelamento_
autorizacoes
plano/api/v1/ws/formulario/get_protocoloGETRetorna os detalhes
de uma solicitação de autorização
do protocolo requerido.


Feature

Endpoint

Método

Descrição

Atualizar protocolo de solicitação de cancelamento de

autorização

plano

/

solicitacao

cancelamento_

autorizacao

plano/api/v1/ws/formulario/atualiza_status_protocolo

POST

Atualiza o status de um protocolo de

solicitação

cancelamento de

autorização

plano solicitado.

3- Parâmetros

Atualização Cadastral - parâmetros

Listagem status de atualização cadastral

FeatureParâmetroObrigatórioTipo

Solicitação de autorização - endpoint

Atualização protocolo

Feature

Endpoint

Método

Descrição

Listagem status solicitação de

atualização cadastralid_operadoratrue

Inteiro

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

Listagem status de autalização cadastral

mshash

true

String

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

Detalhes protocolo de atualização cadastral

FeatureParâmetroObrigatórioTipoDescriçãoDetalhes protocolo de atualização cadastralid_operadoratrue
Inteiro

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

Detalhes protocolo de atualização cadastral

mshash

true

String

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

Detalhes protocolo de atualização cadastralid_protocolotrue
Inteiro
ID do protocolo requerido.

autorização

/solicitacao_autorizacoes/api/v1/ws/formulario/get_all_status

GET

Retorna os tipos de status de Solicitações de Autorizações.


Feature

Endpoint

Método

Descrição

Detalhes de uma solicitação de autorização

/solicitacao_autorizacoes/api/v1/ws/formulario/get_protocolo

GET

Retorna os detalhes de uma solicitação de autorização.


Feature

Endpoint

Método

Descrição

Atualizar protocolo de solicitação de autorização

/solicitacao_autorizacao/api/v1/ws/formulario/atualiza_status_protocoloPOSTAtualiza protocolo de solicitação de autorização.


3- Parâmetros


Atualização Cadastral - parâmetros

Listagem status de atualização cadastral

FeatureParâmetroObrigatórioTipoDescrição
Atualização protocolo
Listagem status de atualização cadastralid_operadoratrue

Inteiro

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

Atualização protocolo atualização
Listagem status de autalização cadastral

mshash

true

String

HASH que identifica de qual ambiente (Homologação

 

ou

 

Produção) os dados serão buscados.

Atualização


Detalhes protocolo de atualização cadastral

matricula
Feature
true
Parâmetro

String

Matrícula do beneficiário

Atualização protocolo
ObrigatórioTipoDescrição
Detalhes protocolo de atualização cadastral
protocolo
id_operadoratrue
StringAtualização protocolo
Inteiro

Protocolo da Solicitação Cadastral.

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

Detalhes protocolo de atualização cadastral
status

mshash

true

Inteiro

Status requerido.

Atualização protocolo atualização cadastral

observacao

false

String

Algumas observações feitas pelo usuário.

Segunda via de cartão - parâmetros

Listagem status de segunda via de cartão

FeatureParâmetros
String

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

Detalhes protocolo de atualização cadastralid_protocolotrue
Inteiro
ID do protocolo requerido.


Atualização protocolo atualização cadastral

FeatureParâmetroObrigatórioTipoDescrição
Listagem status de segunda via de cartãoAtualização protocolo atualização cadastralid_operadoratrue
Inteiro

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

Listagem status de segunda via de cartãoAtualização protocolo atualização cadastralmshashtrue
String
HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados.

Listagem solicitação segunda via de cartão

FeatureParâmetroObrigatórioTipoDescriçãoListagem solicitação segunda via de cartãoid_operadoratrue
Inteiro

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

Listagem solicitação segunda via de cartão

mshash

true

String

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

Listagem forma de entrega
Atualização protocolo atualização cadastral

matricula

true

String

Matrícula do beneficiário

Atualização protocolo atualização cadastral

protocolo

true

String

Protocolo da Solicitação Cadastral.

Atualização protocolo atualização cadastral

status

true

Inteiro

Status requerido.

Atualização protocolo atualização cadastral

observacao

false

String

Algumas observações feitas pelo usuário.

Segunda via de cartão - parâmetros

Listagem status de segunda via de cartão

FeatureParâmetrosObrigatórioTipoDescrição
Listagem forma status de entrega segunda via de cartãoid_operadoratrue
Inteiro

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

Listagem forma status de entrega segunda via de cartão

mshash

true

String

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

Atualizar protocolo


Listagem solicitação segunda via de cartão

Atualizar protocolo
FeatureParâmetroObrigatórioTipoDescrição
Atualizar protocolo Listagem solicitação segunda via de cartãoid_solicitacao_cartaooperadoratrue
Inteiro

Id da solicitação de segunda via do cartão.

Atualizar protocolo segunda via de cartãoid_status_cartaotrue
Inteiro
Id do status atual da solicitação de segunda via do cartão.

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

Listagem solicitação segunda via de cartão

mshash

true

String

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

Reembolso - parâmetros


Listagem

status de reembolso

forma de entrega segunda via de cartão

FeatureParametroParâmetrosObrigatórioTipoDescrição
Listagem status de reembolsoforma de entrega segunda via de cartãoid_operadoratrue
Inteiro

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

Listagem status de reembolsoforma de entrega segunda via de cartão

mshash

true

String

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

Listagem tipo de reembolso


Atualizar protocolo segunda via de cartão

Listagem tipo de reembolso
FeatureParâmetroObrigatórioTipoDescrição
Listagem tipo de reembolsoAtualizar protocolo segunda via de cartãoid_operadorasolicitacao_cartaotrue
Inteiro

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

solicitação de segunda via do cartão.

Atualizar protocolo segunda via de cartãoid_status_cartaotrue
Inteiro
Id do status atual da solicitação de segunda via do cartão.
Atualizar protocolo segunda via de cartão

mshash

true

String

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

Reembolso - parâmetros

Listagem

destalhes do

status de reembolso

FeatureParâmetroParametroObrigatórioTipoDescrição

Listagem

destalhes do

status de reembolso

id_operadoratrue
Inteiro

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

Listagem

destalhes do

status de reembolso

mshash

true

String

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


Listagem

destalhes do reembolsoid_reembolsotrue
Inteiro
ID do reembolso que deseja buscar os detalhes.

Atualizar protocolo de reembolso

Feature

tipo de reembolso

Atualizar protocolo
FeatureParâmetroObrigatórioTipoDescrição
Atualizar protocolo Listagem tipo de reembolsoprotocoloid_operadoratrue
Inteiro

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

Listagem tipo de reembolsoid_reembolso

mshash

true

Inteiro
Atualizar protocolo de reembolsoid_status_reembolsotrue
Inteiro
Atualizar protocolo de reembolsoobservacaofalse
String
Atualizar protocolo de reembolsodespesas[0][id_status_reembolso]true
Inteiro
Atualizar protocolo de reembolsodespesas[0][valor_reembolsado]true
Float
Atualizar protocolo de reembolsodespesas[0][valor_coparticipacao]true
Float
Atualizar protocolo de reembolsodespesas[0][valor_uso_indevido]true
Float
Atualizar protocolo de reembolsodespesas[0][valor_glosado]true
Float
Atualizar protocolo de reembolsodespesas[0][id_despesa_reembolso]
String

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


Listagem destalhes do reembolso

FeatureParâmetroObrigatórioTipoDescrição
Listagem destalhes do reembolsoid_operadoratrue
Inteiro

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

Listagem destalhes do reembolso

mshash

true

String

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

Listagem destalhes do reembolsoid_reembolsotrue
Inteiro
ID do reembolso que deseja buscar os detalhes.


Atualizar protocolo de reembolso

FeatureParâmetroObrigatórioTipoDescrição
Atualizar protocolo de reembolsoprotocolotrue
Inteiro

Atualizar protocolo de reembolsoid_reembolsotrue
Inteiro

Atualizar protocolo de reembolsodataid_status_pagamentoreembolsotrue
StringInteiro

Atualizar protocolo de reembolsonumero_lotetrue
Inteiro
Atualizar protocolo de reembolso

mshash

true

String

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

observacaofalse
String

Atualizar protocolo de reembolsodespesas[10][id_despesastatus_reembolso]true
Inteiro

Atualizar protocolo de reembolsodespesas[10][valor_glosadoreembolsado]true
InteiroFloat

Atualizar protocolo de reembolsodespesas[10][idvalor_status_reembolsocoparticipacao]true
InteiroFloat

Atualizar
usuário atribuído na análise
Atualizar usuário atribuído na análise
protocolo de reembolso
FeatureParâmetroObrigatórioTipoDescrição

Atualizar usuário atribuído na análise de reembolso

id_reembolsotrue
Inteiro

Id do reembolso para a qual será atualizado.

Atualizar usuário atribuído na análise de reembolsoid_ms_usuariotrue
Inteiro
despesas[0][valor_uso_indevido]true
Float

Atualizar protocolo de reembolsodespesas[0][valor_glosado]true
Float

Atualizar protocolo de reembolsodespesas[0][id_despesa_reembolso]true
Inteiro

Atualizar protocolo de reembolsodata_pagamentotrue
String

Atualizar protocolo de reembolsonumero_lotetrue
Inteiro

Atualizar protocolo de reembolso

mshash

falsetrue

String

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

Cancelamento
Atualizar protocolo de
plano

Listagem status cancelamento de plano

FeatureParâmetrosObrigatórioTipoDescrição
Listagem status cancelamento de planoid_operadoratrue
Inteiro

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

Listagem status cancelamento de plano

mshash

true

reembolsodespesas[1][id_despesa_reembolso]true
Inteiro

Atualizar protocolo de reembolsodespesas[1][valor_glosado]true
Inteiro

Atualizar protocolo de reembolsodespesas[1][id_status_reembolso]true
Inteiro


Atualizar usuário atribuído na análise de reembolso

FeatureParâmetroObrigatórioTipoDescrição

Atualizar usuário atribuído na análise de reembolso

id_reembolsotrue
Inteiro

Id do reembolso para a qual será atualizado.

Atualizar usuário atribuído na análise de reembolsoid_ms_usuariotrue
Inteiro

Atualizar usuário atribuído na análise de reembolso

mshash

false

String

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

Detalhes de uma solicitação de

Cancelamento de plano

Listagem status cancelamento de plano

FeatureParâmetrosObrigatórioTipoDescrição
Detalhes de uma solicitação de Listagem status cancelamento de planoid_operadoratrue
Inteiro

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

Detalhes de uma solicitação de Listagem status cancelamento de plano

mshash

true

String

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


Detalhes de uma solicitação de cancelamento de plano

id_protocolotrue
Inteiro
ID do protocolo requerido.

Atualizar uma solicitação de cancelamento de plano

FeatureParâmetroParâmetrosObrigatórioTipoDescrição
Atualizar

Detalhes de uma solicitação de cancelamento de plano

id_operadoratrue
Inteiro

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

Atualizar

Detalhes de uma solicitação de cancelamento de plano

mshash

true

String

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

Atualizar

Detalhes de uma solicitação de cancelamento de plano

matriculaid_protocolotrue
StringInteiro
Matrícula ID do beneficiárioprotocolo requerido.


Atualizar uma solicitação de cancelamento de plano

protocolotrueProtocolo da Solicitação Cadastral.
FeatureParâmetroObrigatório
String
TipoDescrição
Atualizar uma solicitação de cancelamento de planostatusid_operadoratrue
Inteiro
Status requerido.

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

Atualizar uma solicitação de cancelamento de planoobservacao

mshash

false

true

String
Algumas observações feitas pelo usuário.

Solicitação de autorização - parâmetros

Listagem solicitação de autorização

FeatureParâmetroObrigatórioTipoDescriçãoListagem solicitação de autorizaçãoid_operadoratrue
Inteiro

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

Listagem solicitação de autorização

mshash

true

String

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

Detalhes de uma

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

Atualizar uma solicitação de cancelamento de planomatriculatrue
String
Matrícula do beneficiário
Atualizar uma solicitação de cancelamento de planoprotocolotrue
String
Protocolo da Solicitação Cadastral.
Atualizar uma solicitação de cancelamento de planostatustrue
Inteiro
Status requerido.
Atualizar uma solicitação de cancelamento de planoobservacaofalse
String
Algumas observações feitas pelo usuário.

Solicitação de autorização - parâmetros

Listagem solicitação de autorização

FeatureParâmetroObrigatórioTipoDescrição
Detalhes de uma Listagem solicitação de autorizaçãoid_operadoratrue
Inteiro

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

Detalhes Listagem solicitação de uma solicitação de autorização

mshash

true

String

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


Detalhes de uma solicitação de autorização

id_protocolotrueInteiro

ID do protocolo requerido.

Atualização de uma solicitação de autorização

FeatureParâmetroObrigatórioTipoDescrição
Atualização Detalhes de uma solicitação de autorizaçãoid_operadoratrue
Inteiro

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

Atualização Detalhes de uma solicitação de autorização

mshash

true

String

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

Atualização Detalhes de uma solicitação de autorizaçãomatriculaid_protocolotrue
StringInteiro
Matrícula ID do beneficiárioprotocolo requerido.


Atualização de uma solicitação de autorização

protocolotrueProtocolo da Solicitação Cadastral.
FeatureParâmetroObrigatório
String
TipoDescrição
Atualização de uma solicitação de autorizaçãostatusid_operadoratrue
Inteiro
Status requerido.

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

Atualização de uma solicitação de autorizaçãoobservacao

mshash

false

true

String
Algumas observações feitas pelo usuário.
4- Exemplo de retorno API (Sucesso) Bloco de código
languagejs
themeMidnight
titleRetorno API sucesso
linenumberstrue
collapsetrue

5- Exemplo de retorno API (Erro)

Bloco de código
languagejs
themeMidnight
titleRetorno API falha
linenumberstrue
collapsetrue
Nota
titleATENÇÃ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

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

Atualização de uma solicitação de autorizaçãomatriculatrue
String
Matrícula do beneficiário
Atualização de uma solicitação de autorizaçãoprotocolotrue
String
Protocolo da Solicitação Cadastral.
Atualização de uma solicitação de autorizaçãostatustrue
Inteiro
Status requerido.
Atualização de uma solicitação de autorizaçãoobservacaofalse
String
Algumas observações feitas pelo usuário.


4- Exemplo de retorno API (Sucesso)

Bloco de código
languagejs
themeMidnight
firstline1
titleRetorno API sucesso
linenumberstrue
collapsetrue
{
    "status": true,
    "data": [],
    "critica": [],
    "timestamp": "2017-08-02T10:52:13-03:00",
    "msg":"Sucesso"
}

5- Exemplo de retorno API (Erro)

Bloco de código
languagejs
themeMidnight
firstline1
titleRetorno API falha
linenumberstrue
collapsetrue

    "status": false,
    "data": [],
    "critica": [
        {
            "cod": 0,
            "descricao": "O status é inválido",
            "origem": "/mssuite/solicitacao_autorizacao/api/v1/ws/formulario/atualiza_status_protocolo/",
            "trace": ""
        }
    ],
    "timestamp": "2019-04-22T11:12:51-03:00",
    "msg": "O status é inválido"
}


Nota
titleATENÇÃO

É importante frizar que a Mobile Saúde está implementando novas políticas de segurança, estamos implementando um novo sistema de Firewall (WAF) para bloqueios que identificarmos como nocivos, onde iremos fortemente atuar em:

  • Requisições que não sejam consideradas válidas;
  • Requisições identificadas como instruções de SQL Injection;

Recomendamos fortemente a tratativa de: Mensagens de erro não tratadas (as famosas excepctions), pois o envio de muitas destas requisições ocasionará que o seu serviço de callback seja paralizado.

Nos casos em que identificamos como tentativas nocivas aos serviçõs da Mobile Saúde repetidamente, iremos adotar o BLOQUEIO do ip de origem e com isso os serviços da operadora podem ser paralizados, em casos de falso positivo entre imediatamente em contato com o setor de Atendimento da Mobile Saúde, pelo nosso chat ou telefone para contato.