| Índice | ||||
|---|---|---|---|---|
|
| Dica |
|---|
Só são suportadas integrações no padrão REST. |
...
Orientações
...
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.
Critérios de preenchimento
...
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.
...
...
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
Método /chavePasse/grupoFamiliar
| Dica |
|---|
|
Retorno
Carrega os dados do grupo familiar pela chave passe.
End-point
Endpoint | Método | Header Content-TypeDescrição | |
|---|---|---|---|
| GET | application/json | Carrega os dados do grupo familiar pela chave passe. |
Parâmetros de
...
Parâmetro
...
Obrigatoriedade
...
Tipo
...
Descrição
...
origem
...
M
...
String
...
URL de origem que faz o request para a API
| Nota |
|---|
A origem deve estar previamente cadastrada no Painel Público - Segurança - Cadastro de Origens. |
Parâmetros de QueryString
Parâmetro | ObrigatoriedadeRequerido | Tipo | Descrição |
|---|---|---|---|
instanciaApp | MSim | String | bundle da aplicação ofuscado (BASE64) |
chavePasse | MSim | String | Chave Passe que foi gerada. |
chaveFuncionalidade | MSim | String | UUID chave da funcionalidade. |
...