...
| Dica |
|---|
Só são suportadas integrações no padrão REST. |
Método “formPreLoadData”
| Dicainfo |
|---|
|
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 |
...
| Bloco de código | ||
|---|---|---|
| ||
url: https://www.operadoradesaude.com.br/mobilesaude/autenticacao/trocarSenhaformPreLoadData Body: { "novaSenha": "teste123", "senhaAtual":"mobi123", "chaveUnica":"10102String", "integracao": { "xpto": "voluptatibus", "xyz": "quibusdam", "abcdef": 9288701 } } |
...
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
mensagemdata | M | String | mensagem para ser exibida para o cliente |
...
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
| Bloco de código | ||
|---|---|---|
| ||
{
"data" : {
"mensagemteste1": "String"Senha,
alterada com sucesso!" } |
Exemplo retorno API - falha
| Bloco de código | ||
|---|---|---|
| ||
{ "mensagemteste2": "Senha inválida!" }"String" } } |
Integrando formPreLoadData ao FormBuilder
...
Visualização no App
...
Retorno da API - Falha
| Aviso |
|---|
|