Histórico da Página
...
| Atributo | Tipo | Descrição | Obrigatório? | Valores |
|---|---|---|---|---|
type** | String | Tipo da informação da situação encontrada. | Sim |
|
message | String | Breve mensagem sobre a situação encontrada. | Sim | |
detail | String | Detalhes sobre a situação encontrada. | Não | |
helpUrl | String | Página de ajuda sobre a situação encontrada. | Não |
Serviços
Serviço público de autenticação
POST /discovery/v1/authentication
Realiza a autenticação do usuário.
O JSON de autenticação deverá conter o código do usuário e a senha. No atributo da senha deverá ser indicado qual o tipo de criptografia foi utilizado na requisição, conforme o exemplo abaixo:
| Bloco de código |
|---|
{
"username": "admin",
"password": "base64:YWRtaW4="
} |
Obs.: por padrão nesta primeira etada a senha será enviada sempre em Base64 e, portanto será recomendado o uso de HTTPS.
No JSON de retorno deverá ser retornado as informações do usuário autenticado conforme a estrutura abaixo:
| Atributo | Tipo | Descrição | Obrigatório? | Valores |
|---|---|---|---|---|
username | String | Código do usuário. | Sim | |
email | String | E-mail do usuário. | Não | |
fullName | String | Nome completo do usuário. | Sim | |
dialect | String | Código de dialeto do usuário para tradução. | Não | pt-BR |
avatar | String | URL ou Base64 com a imagem de avatar do usuário. | Não | |
token | String | Token JWT de autenticação que será utilizada nas requisições. | Sim |
Obs.: se a autenticação não for bem sucedidade, deverá ser retornado o código de erro HTTP padrão para esta ocasião: 401 Unauthorized (usuário ou senha inválidos) ou 403 Forbidden (usuário sem privilégios para utilizar o sistema).
Exemplo JSON de retorno
| Bloco de código | ||
|---|---|---|
| ||
{
"username": "john",
"email": "[email protected]",
"fullName": "John Doe",
"dialect": "en-US",
"avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ"
} |
Serviço restrito de busca dos ambientes disponíveis
GET /discovery/v1/environments/{name}
...
| Atributo | Tipo | Descrição | Obrigatório? | Valores |
|---|---|---|---|---|
name | String | Nome do ambiente. | Sim |
Exemplo JSON de retorno
| Bloco de código | ||
|---|---|---|
| ||
{
"total": 2,
"hasNext": false,
"items": [{
"name": "PRODUCAO"
},{
"name": "HOMOLOGACAO"
}]
} |
...
| Atributo | Tipo | Descrição | Obrigatório? | Valores |
|---|---|---|---|---|
name | String | Nome do ambiente. | Sim | |
host | String | IP ou domínio do recurso. | Sim | |
port | Number | Porta do recurso. | Não | |
category | String | Categoria do recurso. | Sim |
|
date | String | Data de descoberta do recurso (no formato yyyy-mm-ddThh:mm:ss.nnnnnn+|-hh:mm). | Sim | |
status | String | Indicador de saúde do recurso. | Não | Health:status |
info | Array | Lista com a estrutura com as informações dos itens avaliados. | Não | Info |
Exemplo JSON de retorno
| Bloco de código | ||
|---|---|---|
| ||
{
"total": 2,
"hasNext": false,
"items": [{
"name": "PRODUCAO",
"host": "10.1.1.1",
"port": 1234,
"category": "server|machine|database|lsv|gateway",
"date": "yyyy-mm-ddThh:mm:ss.nnnnnn+|-hh:mm",
"status": "success|warning|error|danger",
"info": [{
"code": "cpu",
"title": "CPU",
"detail": "Central Processing Unit",
"value": "90",
"health": [{
"status": "success|warning|error|danger",
"message": "Consumo de CPU em 80%",
"details": "O alto consumo da CPU do servidor prejudica o desempenho do sistema",
"helpUrl": "http://www.tdn.totvs.com.br"
}, {
"status": "success|warning|error|danger",
"message": "Memória disponível no servidor abaixo da recomendada",
"details": "O recomendado para o uso do TOTVS Microsiga Protheus é de no mínimo 8gb de RAM",
"helpUrl": "http://www.tdn.totvs.com.br"
}]
}]
}]
} |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas