...
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 de gerar token temporário
Informações |
---|
|
Endpoint
Endpoint | Método | Header Content-Type | Descrição |
---|
https:// |
api.mosiaomnichannel.com |
.br/clientes/auth/temp-authorization |
GET | application/json | Endpoint para gerar token temporário. |
Headers
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
Authorization | M | String | Token de autenticação da operadora. |
content-type | M | application/json | Tipo de Conteúdo enviado para a requisição. |
Descrição dos objetos e atributos de retorno - Sucesso
Atributo | Critério | Tipo | Descrição |
---|---|---|---|
message | M | String | Mensagem com motivo do erro. |
status | M | Boolean | Status de retorno. |
data | M | Object | Dados do token temporário. |
statusCode | M | Number | Código de status HTTP. |
timestamp | M | Number | Data do retorno do resultado. |
Objeto data
Atributo | Critério | Tipo | Descrição |
---|---|---|---|
token | M | String | Token a ser utilizado nas requisições onde a autenticação temporária é aceita. |
expireAt | M | Number | Data em timestamp que o token será expirado. O token sempre será expirado 12 horas após ser gerado. |
Exemplo retorno API - sucesso
...
Aviso |
---|
|
O erro sempre é retornado no status code 401, não autorizado.
Atributo | Critério | Tipo | Descrição |
---|---|---|---|
message | M | String | Mensagem com motivo do erro. |
success | M | Boolean | Sempre retornará false |
Exemplo retorno API - falha
...