API Aplicações

Chamadas de API para operação dos objetos Aplicações (Aplicações Disponíveis aos Usuários).

Base path: /apps/

Você poderá utilizar esta API em situações onde o controle de aplicações disponíveis aos usuários seja fragmentado por cliente. Caso utilize controles de aplicações através de permissões dentro das instâncias de template, esta API não precisará ser utilizada.

Nota: A aplicação quando cadastrada é, por padrão, cadastrada na situação de INATIVA. Utilize a chamada de ativação para ativar a aplicação após o cadastramento.

---

Listar Aplicações

Realiza a consulta dos aplicativos cadastrados na plataforma Autosky e vinculados aos clientes.

GET /apps/

Parâmetros de Query (opcionais)

Parâmetro	Tipo	Descrição
cli_uuid	string	UUID do cliente para filtro

Resposta

Status: 200 OK

[
    {
        "app_uuid": "90476973-4729-4f2b-acee-3621cebd70e8",
        "nome": "Notepad",
        "estado": "INATIVO",
        "endereco_app": "",
        "parametro_app": "",
        "nome_exibicao": ""
    },
    {
        "app_uuid": "84104ec2-6914-4ed7-a359-04ff14316e74",
        "nome": "Calculadora",
        "estado": "ATIVO",
        "endereco_app": "",
        "parametro_app": "",
        "nome_exibicao": ""
    }
]

---

Obter dados de uma aplicação

Obtém dados de uma aplicação especificada por seu UUID. Além dos campos da listagem, também inclui o campo cliente.

GET /apps/{app_uuid}

Parâmetros de Path

Parâmetro	Obrigatório	Descrição
app_uuid	Sim	UUID da aplicação

Resposta

Status: 200 OK

{
    "app_uuid": "84104ec2-6914-4ed7-a359-04ff14316e74",
    "nome": "Calculadora",
    "estado": "ATIVO",
    "endereco_app": "",
    "parametro_app": "",
    "cliente": {
        "cli_uuid": "79ea8324-4889-4729-8bf0-bc1c40b38273",
        "nome": "MeuCliente001",
        "grupo_seguranca": "Cliente001",
        "email_admin": "[e-mail]",
        "has_license_limit": false,
        "license_limit": 0,
        "amb_uuid": "715088c9-9f21-424e-bcd5-5eacc0ce165b"
    },
    "nome_exibicao": ""
}

---

Cadastrar Aplicação

Realiza o cadastramento de uma nova aplicação na plataforma.

POST /apps/

Body da Requisição

Campo	Tipo	Obrigatório	Descrição
nome	string	Sim	Nome da aplicação
cli_uuid	string	Sim	UUID do cliente
estado	string	Sim	Estado da aplicação: ATIVO ou INATIVO
endereco_app	string	Não	Endereço do aplicativo (ex: C:\\Program Files\\MeuDir\\App.exe)
parametro_app	string	Não	Parâmetro de inicialização do aplicativo

Exemplo de Requisição

{
    "nome": "Teste API",
    "cli_uuid": "54368a47-8040-4cc7-b20b-8b9cc2e86124",
    "estado": "ATIVO"
}

Resposta

Status: 200 OK

{
    "nome": "teste",
    "estado": "ATIVO",
    "endereco_app": "C:\\\\Program Files\\MeuDir\\App.exe",
    "parametro_app": "CLI:1220",
    "cliente": {
        "cli_uuid": "123-123-123-123",
        "name": "Client name",
        "group_name": "Client group-name",
        "email_admin": "[e-mail]",
        "has_license_limit": false,
        "license_limit": 0,
        "in_maintenance": false,
        "maintenance_msg": ""
    },
    "nome_exibicao": ""
}

---

Editar Aplicação

Realiza a edição da aplicação na plataforma.

PUT /apps/{app_uuid}

Parâmetros de Path

Parâmetro	Obrigatório	Descrição
app_uuid	Sim	UUID da aplicação

Body da Requisição

Campo	Tipo	Obrigatório	Descrição
nome	string	Sim	Nome da aplicação
cli_uuid	string	Sim	UUID do cliente
estado	string	Não	Estado da aplicação: ATIVO ou INATIVO
endereco_app	string	Sim	Endereço do aplicativo
parametro_app	string	Não	Parâmetro de inicialização

Exemplo de Requisição

{
    "nome": "teste",
    "cli_uuid": "09228c2a-a9a6-4cab-8c57-81620f20bc2f",
    "endereco_app": "C:\\\\Program Files\\MeuDir\\App.exe"
}

Resposta

Status: 200 OK

Retorna o objeto completo da aplicação atualizada com o objeto cliente.

---

Remover Aplicação

Realiza a exclusão de uma aplicação na plataforma.

DELETE /apps/{app_uuid}

Parâmetros de Path

Parâmetro	Obrigatório	Descrição
app_uuid	Sim	UUID da aplicação

Resposta

Status: 200 OK

{
    "status": "success"
}