...
| Dica |
|---|
Só são suportadas integrações no padrão REST. |
| Nota |
|---|
OrientaçõesParâmetros de entradaSerã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.
...
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
Método /chavePasse/usuario
...
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
| GET | application/json | Carrega os dados do usuário através da 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. É o campo chave gerado automaticamente no cadastro da funcionalidade. |
Exemplo de Retorno de Sucesso
...