1.7 - formPreLoadData

Índice

Só são suportadas integrações no padrão REST.

Método “formPreLoadData”

Atente-se as orientações fornecidas pela Mobile Saúde;
Atente-se aos critérios de preenchimento;
Atente-se aos critérios de objetos e atributos de retorno;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

Esta integração sempre será executada antes de renderizar qualquer um formulário

Endpoint

Endpoint

Método

Header Content-Type

Descrição

exemplo.com/formPreLoadData

POST

application/json

Endpoint de formPreLoadData.

Importante: o nome do método é sugerido, podendo ser configurado com outro nome caso necessário.

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

Serão enviados no BODY os seguintes parâmetros:

Atributo	Obrigatoriedade	Tipo	Descrição
chaveUnica	M	String	Chave de identificação do usuário retornada no login
integracao	OP	Objeto	nó integração retornado no login
idFuncionalidade	M	String	Código da funcionalidade que está acionando a integração, deve ser utilizada para controlar quais dados são retornados

Exemplo request

url: 
https://www.operadoradesaude.com.br/mobilesaude/autenticacao/formPreLoadData

Body:
{
  "chaveUnica":"String",
  "numeroContrato" : "String",
  "integracao": {
    "xpto": "voluptatibus",
    "xyz": "quibusdam",
    "abcdef": 9288701
  }
}

Descrição dos objetos e atributos de retorno - Sucesso

Está indicado abaixo a estrutura de retorno do seu método login. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
data	M	Array de objetos ”data”	Retorna um array de objetos “data”	Deve retornar um array de objetos

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
value	C	String	Definir nome para o atributo	Formato: Texto livre.

Retorno da API - Sucesso

{
 "data" : {
     "teste1": "String",
     "teste2": "String"
  } 
}

Integrando formPreLoadData ao FormBuilder

Visualização no App

Retorno da API - Falha

Atente-se as mensagens de retorno para cada HTTPS Status Code;
Siga as instruções de Descrição dos objetos e atributos de retorno - falha;