Ir para o final dos metadados
Ir para o início dos metadados

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 6 Próxima »

Tópicos:

1- URL base API


2- Endpoints

Atualização Cadastral 

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

Feature

Endpoint

Método

Descrição

Listagem status de segunda via de cartão

/solicitacao_cartao/v1/api/status/listar

GET

Lista completa de status de solicitação do cartão

Feature

Endpoint

Método

Descrição

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

/solicitacao_cartao/v1/api/motivoSolicitacao/listar

GET

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

Feature

Endpoint

Método

Descrição

Detalhes de segunda via der cartão

/atualizacao_cadastral/api/v1/ws/formulario/carregar

GET

Detalhes de uma solicitação de cartão

Feature

Endpoint

Método

Descrição

Listagem formas de entregas segunda via de cartão

/solicitacao_cartao/v1/api/formaEntrega/listar

GET

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

Feature

Endpoint

Método

Descrição

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

/solicitacao_cartao/v1/api/solicitacao/atualizarStatus

POST

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

Reembolso

Feature

Endpoint

Método

Descrição

Listagem status solicitação de reembolso

/plataforma_beneficiario/reembolso_online/v1/api/status/listar

GET

Listagem com os status de Reembolso solicitados.

Feature

Endpoint

Método

Descrição

Listagem tipos de solicitação de reembolso

/plataforma_beneficiario/reembolso_online/v1/api/tipoReembolso/listar

GET

Listagem com os tipos de Reembolso cadastrados.

Feature

Endpoint

Método

Descrição

Detalhes de uma solicitação de reembolso

/plataforma_beneficiario/reembolso_online/v1/api/reembolso/detalhes

GET

Listagem com os detalhes de um pedido de reembolso.

Feature

Endpoint

Método

Descrição

Atualizar protocolo de solicitação de reembolso

/plataforma_beneficiario/reembolso_online/v1/api/reembolso/atualizar

POST

Atualizar pedido de reembolso realizado.

Feature

Endpoint

Método

Descrição

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

/plataforma_beneficiario/reembolso_online/v1/api/reembolso/atualizar

POST

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

Cancelamento de plano

Feature

Endpoint

Método

Descrição

Listagem status cancelamento de plano

/cancelamento_plano/api/v1/ws/formulario/get_all_status

GET

Retorna os tipos de status de cancelamento de plano.

Feature

Endpoint

Método

Descrição

Detalhes de uma solicitação de cancelamento de plano

/cancelamento_plano/api/v1/ws/formulario/get_protocoloGETRetorna os detalhes do protocolo requerido.

Feature

Endpoint

Método

Descrição

Atualizar protocolo de solicitação de cancelamento de plano

/cancelamento_plano/api/v1/ws/formulario/atualiza_status_protocolo

POST

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

Solicitação de autorização

Feature

Endpoint

Método

Descrição

Listagem status solicitação de 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

ParâmetroObrigatórioTipoDescrição
id_operadoratrue
Inteiro

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

mshash

true

String

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


4- Exemplo de retorno API (Sucesso)

Retorno API sucesso
 

5- Exemplo de retorno API (Erro)

Retorno API falha
 

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


  • Sem rótulos