| Índice |
|---|
Informações
...
| Abreviação | Nome | Descrição |
|---|---|---|
| M | Mandatório | O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado. |
| C | Condicional | O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado. |
| OP | Opcional | Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array |
...
Endpoint | Método | Header Content-Type | Descrição | |||||
|---|---|---|---|---|---|---|---|---|
exemplo.com/login
| POST | application/json | Endpoint de login |
Parâmetros de entrada
...
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| matricula | M | String | Matrícula do beneficiário. Informar a matrícula completa, sem espaços ou caracteres especiais | ASCII (nao permite especiais - sem acentos, por exemplo). Será impressa no cartão |
| matriculaAntiga | OP | String | Matrícula do beneficiário no sistema antigo. Em alguns casos o cliente continua utilizando a matrícula do sistema antigo mesmo após trocar de sistema de gestão, para manter funcionando integrações com outros sistemas legados. Por este motivo é importante termos essa informação. | ASCII (nao permite especiais - sem acentos, por exemplo) |
| matriculaFuncionario | OP | String | Indicar o código da matrícula de funcionário na empresa patrocinadora, caso aplicável. | ASCII (nao permite especiais - sem acentos, por exemplo) |
| matriculaTitular | M | String | Informe a matrícula do titular | ASCII (nao permite especiais - sem acentos, por exemplo). Informar a matrícula do titular da família. Se o beneficio em questão for o próprio titular, repita o conteúdo o campo “matricula” |
| nomeTitular | M | String | Informe o nome do titular | ASCII (nao permite especiais - sem acentos, por exemplo). Informe o nome do titular da família. Se o beneficio em questão for o próprio titular, repita o conteúdo o campo “nome” |
| emailTitular | OP | String | Informe o e-mail do titular | Validar com regras de e-mail válido, se preenchido. |
| telefoneTitular | OP | String | Informe o telefone do titular | Permitir entrada somente números. |
| celularTitular | OP | String | Informe o telefone celular do titular | Permitir entrada somente números. |
| cpfTitular | M | String | Informe o CPF do titular | Permitir entrada somente números. Informe o número do CPF do titular da família. Se o beneficio em questão for o próprio titular, repita o conteúdo o campo “cpf” |
| nome | M | String | Nome do beneficiário | Não permitir números, nem caracteres especiais. Permitido acentos |
| nomeSocial | OP | String | Informe o nome social do beneficiário | Não permitir números, nem caracteres especiais. Permitido acentos |
| sexo | M | String | Informar o sexo do usuário | M = Masculino / F = Feminino / N = Não se aplica. Apenas maiúsculos |
| dataNascimento | M | String | Data de nascimento do beneficiário | Formato: YYYY-MM-DD |
| cpf | OP | String | CPF do beneficiário | Somente números. Tamanho mínimo / máximo 11 posições. |
| celular | OP | String | Informar o numero do telefone celular do beneficiário | Tamanho mínimo / máximo 11. |
| telefone | OP | String | Informe o número de telefone do beneficiário | Tamanho mínimo / máximo 10. |
| OP | String | Email precisa ser válido. | ||
| endereco | OP | String | Endereço | Formato: Texto livre. |
| bairro | OP | String | Bairro | Formato: Texto livre. |
| cep | OP | String | CEP | Formato: Texto livre. |
| cidade | M | String | Cidade | Enviar conforme descrição do IBGE |
| estado | M | String | Estado | Enviar conforme sigla do IBGE (SC, ES, SP, RJ, etc). Tamanho mínimo / máximo 2 posições. Somente letras. Apenas maiúsculas |
| complemento | OP | String | Complemento do endereço | Formato: Texto livre. |
| numeroEndereco | OP | String | Número do endereço | Formato: Texto livre. |
| tipoUsuario | M | String | Informe o tipo de usuário | T = Titular / D = Dependente / A = Agregado. Importante. Só pode existir um (1) usuário no Array de beneficiários com a propriedate tipoUsuario = T por contrato |
| grauParentescoId | M | String | Código do grau de parentesco do beneficiário em relação ao titular | Indicar o ID do grau de parentesco |
| grauParentescoDescricao | M | String | Descrição do Grau de Parentesco | Formato: Texto livre. |
| dataContratacao | M | String | Data da contratação do plano de saúde. Obrigatório PIN-SS conforme RN 389. | Formato: YYYY-MM-DD |
| dataInicioCobertura | M | String | Data do início da cobertura contratual do beneficiário no plano privado de assistência à saúde. Obrigatório no cartão devido a RN 389 | Formato: YYYY-MM-DD |
| convenioId | M | String | Código do plano (produto) do usuário. Este código é fundamental para diferenciação da imagem do cartão, direcionamento (segmentação) de campanhas, mensagens e notícias, além de diversas outras funções no aplicativo e web. | Formato: Texto livre. |
| convenioDescricao | M | String | Texto descritivo do nome do plano (produto) do beneficiário. Informar o nome comercial junto a ANS | Formato: Texto livre. |
| convenioAbrangencia | OP | String | Texto descritivo do nome do plano (produto) do beneficiário. Informar o nome comercial junto a ANS Obrigatório no cartão devido a RN 389 | Formato: Texto livre. |
| convenioAbrangenciaVerso | OP | String | Texto descritivo da abrangência contido no verso do cartão do PTU 5.1. Não tem efeito para operadoras fora do sistema Unimed | Formato: Texto livre. |
| convenioAcomodacao | OP | String | Texto descritivo do padrão de acomodação do plano do beneficiário, conforme ANS | Formato: Texto livre. |
| convenioModalidadeCobranca | OP | String | Texto descritivo da modalidade de cobrança do contrato do beneficiário, como por exemplo: Pré-pagamento, Pós-pagamento e etc. | Formato: Texto livre. |
| convenioPadraoConforto | OP | String | Texto descritivo do padrão de conforto do plano (produto) | Formato: Texto livre. |
| convenioParticipativo | OP | Boolean | Campo para informar se o plano (produto) do beneficiário possui coparticipação ou não. | True/False |
| convenioSegmentacao | OP | String | Texto descritivo da segmentação do plano do (produto). Exemplo de segmentação: Ambulatorial + Hospitalar com Obstetrícia. Sugere-se utilizar as segmentações definidas pela ANS, conforme registro de produtos. | Formato: Texto livre. |
| convenioTipoPessoa | OP | String | Tipo de contrato do plano (produto) do beneficiário Exemplo: Pessoa Física ou Pessoa Jurídica | Formato: Texto livre. |
| convenioTipoContrato | M | String | Informação sobre o tipo de contratação do plano privado de assistência à saúde, conforme RN 195. Individual/Familiar, coletivo por adesaão ou coletivo empresarial. | Formato: Texto livre. |
convenioRegulamentacao | M | String | Informação sobre a regulamentação do plano, entendendo-se por: Regulamentado / adaptado / não regulado. | Formato: Texto livre. |
cartaoValidade | OP | String | Informe textos como "Indefinida" ou "31/12/2020", ou "Vencido" | Formato: Texto livre. |
cartaoVia | OP | Numérico | Indica o numero da via do cartão vigente do beneficiário | Somente números inteiros |
| chaveEmpresaContratante | M | String | Código identificador da empresa contratante do plano do beneficiário (nos casos de planos coletivos por adesão ou coletivos empresariais). Observação: este código é fundamental para diferenciação da imagem do cartão, direcionamento (segmentação) de campanhas, mensagens e noticias, além de diversas outras funções no aplicativo e web | |
| nomeEmpresaContratante | M | String | Nome da empresa contratante Obrigatório PIN-SS conforme RN 389. | |
| contratoEmpresaContratante | M | String | Numero do contrato/apólice. Obrigatório PIN-SS conforme RN 389 | |
| numeroCns | OP | String | Numero do Cartão Nacional de Saúde. Obrigatório no cartão do beneficiário conforme RN 389. | Formato: Texto livre. |
| convenioAns | OP | String | Número de registro do plano do beneficiário na ANS. | Formato: Texto livre. |
| dataFinalCpt | OP | String | Data final da CPT do cliente, quando houver, no formato String. Pode-se informar também textos indicativos, de acordo com a necessidade da operadora. Obrigatório no cartão do beneficiário conforme RN 389. | Formato: Texto livre. |
| codigoContrato | M | String | Código que identifica de qual contrato esse usuário está vinculado. | ASCII (nao permite especiais). Este código deve ser o mesmo do campo codigoContrato da estrutura “contratos“ |
| redeAtendimento | OP | String | Informe o código e a descrição da Rede de Atendimento do beneficiário Observação PTU 5.1: campo obrigatório | ASCII (nao permite especiais). |
| modeloCartao | OP | String | Indique o layout de cartão que deve ser exibido. O dado aqui deve ser idêntico ao acordado entre sua empresa e a Mobile Saúde, na documentação de layouts de cartões | ASCII (nao permite especiais). Torna-se obrigatório quando o cartão virtual foi contratado. |
| carencias | OP | Array de objeto "carencia" | Retorna uma lista de estruturas “carencia” contendo as instruções sobre as carências do usuário. Essa informação só é necessária se houver necessidade de apresentar as carências no cartão virtual. | Caso não exista nenhuma carência, envie o array vazio |
| custom | OP | Array de objetos "custom" | ||
| integracao | M | Objeto | Informações necessárias para realizar a identificação do beneficiário no sistema. A estrutura aqui enviada será enviada no corpo das demais requisições de integração junto com os dados preenchidos pelo beneficiário no sistema. | Não possui Atenção! A regra de preenchimento , pode ser enviada qualquer estrutura desde que seja um Objeto JSON válidodeve obedecer a estrutura chave / valor. Objetos complexos (array de objetos) não são suportados. |
| cooperativas | OP | Objeto | As cooperativas Unimed, que possuem suas particularidade devem utilizar esse objeto para transacionar informações sobre cartão virtual, e outros temas de relevância para seu negócio. | Preenchimento condicional, se a Unimed necessitar. Empresas fora do sistema Unimed não devem considerar o uso deste objeto. |
...
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
chave | M | String | Nome do parâmetro no header aonde será enviado o valor da propriedade token. | ASCII (nao permite especiais) |
token | M | String | Valor do token que será enviado no header, em caso de tokens no padrão Bearer, JWT, Api-Key etc. enviar o prefixo junto do token. Ex: JWT 123xyz | Formato: Texto livre |
| expiracao | O | Number | Caso o token tenha data de expiração, deve ser retornado nessa propriedade o timestamp da data na qual o token irá expirar. | Timestamp (em milissegundos) |
...
Utilize esse objeto para repassar atributos para métodos auxiliares, chamados após execução deste método. O conteúdo deste objeto será repassado integralmente para os próximos métodos do app, facilitando a interpretação de outros sistemas e parâmetros exclusivos de sua aplicação.
| Nota | ||
|---|---|---|
| ||
A regra de preenchimento deve obedecer a estrutura chave / valor. Objetos complexos (array de objetos) não são suportados. |
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| chave | M | String | Nome da propriedade | Formato: Texto livre. |
| valor | OP | String | Valor da propriedade | Formato: Texto livre. |
...
Endpoint
| POST | application/json | Endpoint de lembrar senha |
Parâmetros de entrada
...
Endpoint | Método | Header Content-Type | Descrição | |||||
|---|---|---|---|---|---|---|---|---|
exemplo.com/trocarSenha
| POST | application/json | Endpoint de trocar senha |
Parâmetros de entrada
...
Endpoint | Método | Header Content-Type | Descrição | |||||
|---|---|---|---|---|---|---|---|---|
exemplo.com/novoUsuario
| POST | application/json | Endpoint para criar acesso de novos usuários |
...
Endpoint | Método | Header Content-Type | Descrição | |||||
|---|---|---|---|---|---|---|---|---|
exemplo.com/reiniciarSenha
| POST | application/json | Endpoint para criar acesso de novos usuários |
...
| Descrição | Código |
|---|---|
Notícia | 0 |
InBox ( caixa de notificações ) | 1 |
| Agendamento On-line | 2 |
| Cartão Virtual | 3 |
| Busca de Rede Credenciada | 4 |
| Busca de Medicamento | 5 |
| Prescrições | 6 |
| Alarmes | 7 |
| Contatos | 8 |
| Extrato de Utilização e Coparticipação | 11 |
| Extrato de Autorizações | 13 |
| Débitos (boletos) | 14 |
| Revistas e Manuais | 18 |
| Declarações (IR, Carta de quitação e Carta de permancia) | 20 |
| Componente Cadastral (PIN-SS) Cadastral | 21 |
| Guia Médico Nacional | 24 |
| Navegador Interno (para abrir links dentro do App) | 29 |
| Fila de Espera | 35 |
| Resultado de Exames | 36 |
| Navegador Externo (para abrir links fora do App, diretamente no navegador) | 37 |
| Solicitação de Segunda Via de Cartão | 38 |
| Solicitação de Atualização Cadastral | 39 |
| Solicitação de Cancelamento de Plano | 42 |
| Botão de Emergencia | 43 |
| Chat | 46 |
| Solicitação de Autorização | 48 |
| Reembolso CMS | 56 |
| Extrato Reembolso | 57 |
| Mosia TeleCare | 58 |
| Detalhes do agendamento | 89 |
| Eventos - exclusivo para o perfil de profissional de saúde | 102 |
| Extrato de Pagamento - exclusivo para o perfil de profissional de saúde | 103 |
| Indicação de Ausência - exclusivo para o perfil de profissional de saúde | 105 |
| Programa de Pontos - exclusivo para o perfil de profissional de saúde | 106 |
| Programa de Cursos - exclusivo para o perfil de profissional de saúde | 110 |
...