# Token
# Layout de Requisição do Gerador de Token
A API gerar token tem com objetivo retornar um token para utilização na API Alterar Requisições e Integrações ao sistema Deps, onde caso o parâmetro "Utilizar token na API" esteja definido como "Sim", deverá ser informado o token gerado por esta API. Como o token conta como uma data de validade, os usários podem definir a duração do token através do parâmetro "Tempo token válido".
Hoje está funcionalidade é de uso da API Alterar Requisições e Integrações, mas caso seja identificada a necessidade de incluir em outras APIs do sistema, podemos estar disponibilizando está funcionalidade em versões futuras.
Para consultar a estrutura dessa API deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Token/Token_TokenGerarToken (opens new window), onde "localhost" representa o nome do servidor que está instalado a API. Ao acessar a URL pode ser visto a estrutura de exemplo do serviço, conforme imagem abaixo:
Segue abaixo documentação referente aos campos necessários para a solicitação (Request) de consumo da API:
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
[ { | ||||
login | Login do usuário no Deps | String | Sim | |
senha | Senha do usuário no Deps | String | Sim | |
} ] |
Exemplo layout JSON
{
"login": "teste",
"senha": "teste123",
}
# Layout de Retorno do Gerador de Token
Segue abaixo os campos retornados ao efetuar uma requisição de limite cliente:
Campo | Descrição | Tipo | Tam. |
---|---|---|---|
{ | |||
token | Token gerado através das credenciais informadas | String | |
dataValidade | Data de validade do token | String | 20 |
} |