| Índice |
|---|
Contexto
Grupos de Autorização é um cadastro a parte da configuração de integração, tem um próprio formulário de cadastro na área de segurança, e também tem sua estrutura validada antes de ser cadastrado.
...
| Informações |
|---|
|
Parâmetros de entrada
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
usuario | M | String | usuário a ser passado no request |
senha | M | String | Senha a ser passada no request. |
Endpoint
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
http://exemplo.com/ autorizacao
| POST | application/json | Endpoint de autorizacao |
Exemplo request
| Bloco de código | ||
|---|---|---|
| ||
curl --location --request POST 'https://demo8374353.mockable.io/autorizacao' \
--header 'Content-Type: application/json' \
--data-raw '{
"usuario":"62591304220",
"senha":"123456"
}' |
...
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 |
|---|---|---|---|---|
auth | M | Objeto auth | Lista parâmetros que devem ser enviados no retorno do webservice | Preencher com o objeto do tipo "auth". |
token | M | String | Token de retorno do webservice | |
chave | M | String | Chave de retorno do webservice | A chave Authorization não pode ser utilizada, pois é reservada às requisições do Mosia Omnichannel |
| Aviso |
|---|
|
Exemplo retorno API - sucesso
...
Objetos e atributos de retorno
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
mensagem | M | String | mensagem para ser exibida para o cliente | texto livre |
Exemplo retorno API - falha
...