Page 1

API Autosky Platform

API de comunicação e integração com a plataforma Autosky da Skyone.

Todos os direitos reservados para Skyone ©

https://skyone.solutions/

Host: https://meudominio.skyinone.net/v2/api/

Formato: API Blueprint (1A)

Group API

Sobre

Esta documentação apresenta as informações necessárias para integração de sistemas e plataformas com a API Autosky. Através desta API, é possível realizar procedimentos de integração com os seguintes objetos:

• Clientes (Grupos de Usuários)

• Usuários

• Aplicações

• Sessões de Usuários

• Autenticação de Usuário

• Logon de Usuários

Versão

V2.3 - (19/07/2024)

Pré-Requisitos

Para utilizar as APIs, é necessário possuir as credenciais e informações de autenticação fornecidas pela equipe de integrações da Skyone.

Exemplo de dados:

• Token de Autenticação: 23a1e4e6f90546e498a8f66cf21e3fb3

• UUID do Ambiente: 6a6c7a07-bef1-4e42-942e-87277a8c2a84

• URL de Homologação: piloto.skyinone.net

• URL de Produção: meudominio.skyinone.net

Autenticação nas Chamadas de API

O token obtido deve ser enviado em todas as requisições à API por meio de uma das duas modalidades a seguir:

1. Token via URL

O token é enviado como um parâmetro de consulta na URL: http://meudominio.skyinone.net/v2/api/clients/?token=xxxxx

2. Token via Header

O token é enviado no cabeçalho HTTP de autorização no seguinte formato: Authorization: xxxxxx

Exemplo de requisição com HTTPie:

http http://meudominio.skyinone.net/v2/api/clients/ Authorization:xxxx

API Clientes [/clients/]

Chamadas de API para operação dos objetos de Cliente (Grupos de Usuários).

Listar Clientes [GET /clients/{?updated_at_after,updated_at_before,cli_uuid,external_client_code}]

Realiza a consulta dos clientes cadastrados na plataforma Autosky.

Parâmetros de Filtro

• updated_at_after (opcional, string) - Filtra clientes atualizados a partir desta data/hora (inclusive). Formato ISO 8601: YYYY-MM-DDTHH:MM:SSZ.

• updated_at_before (opcional, string) - Filtra clientes atualizados até esta data/hora (inclusive). Formato ISO 8601: YYYY-MM-DDTHH:MM:SSZ.

• cli_uuid (opcional, string ou array) - Filtra por identificador(es) único(s) do cliente.

  • Valor único: ?cli_uuid=uuid1

  • Múltiplos valores: ?cli_uuid=uuid1,uuid2

• external_client_code (opcional, string ou array) - Filtra pelo(s) código(s) externo(s) associado(s) ao cliente.

  • Valor único: ?external_client_code=code1

  • Múltiplos valores: ?external_client_code=code1,code2

Resposta 200 (application/json)

[
  {
    "cli_uuid": "0e92037b-ed77-4a38-ab35-909637bea146",
    "nome": "Client Name",
    "external_client_code": "External Client Code 1",
    "grupo_seguranca": "Partner.Client-AD-Group-Name.9125b66",
    "email_admin": "[e-mail]",
    "has_license_limit": false,
    "license_limit": 0,
    "amb_uuid": "715088c9-9f21-424e-bcd5-5eacc0ce165b",
    "in_maintenance": false,
    "maintenance_msg": "",
    "schedule_maintenance": false,
    "schedule_maintenance_start": null,
    "schedule_maintenance_end": null,
    "schedule_maintenance_msg": "",
    "terminate_sessions": false,
    "schedule_warning": false,
    "schedule_warning_start": null,
    "schedule_warning_end": null,
    "schedule_warning_msg": "",
    "display_warning_to_logged_users": false,
    "user_latest_login_at": null,
    "created_at": "2025-03-13T11:47:45.445637-03:00",
    "updated_at": "2025-03-13T11:47:45.445637-03:00",
    "migrated_at": null,
    "observations": "",
    "active_sessions_count": 0
  },
  {
    "cli_uuid": "9125b661-952a-42c9-966b-6826775c5a9c",
    "nome": "Client 2",
    "external_client_code": "External Client Code 2",
    "grupo_seguranca": "Partner.Client-AD-Group-Name.1125b56",
    "email_admin": "[e-mail]",
    "has_license_limit": false,
    "license_limit": 0,
    "amb_uuid": "dd2f7c4e-8dee-4ecc-8033-f21207945d55",
    "in_maintenance": false,
    "maintenance_msg": "",
    "schedule_maintenance": false,
    "schedule_maintenance_start": null,
    "schedule_maintenance_end": null,
    "schedule_maintenance_msg": "",
    "terminate_sessions": false,
    "schedule_warning": false,
    "schedule_warning_start": null,
    "schedule_warning_end": null,
    "schedule_warning_msg": "",
    "display_warning_to_logged_users": false,
    "user_latest_login_at": null,
    "created_at": "2025-03-13T11:47:45.445637-03:00",
    "updated_at": "2025-03-13T11:47:45.445637-03:00",
    "migrated_at": "2025-03-13T11:49:06.616983-03:00",
    "observations": "",
    "active_sessions_count": 0
  }
]

Obter dados de um cliente [GET /clients/{cli_uuid}]

Retorna os dados de um cliente específico detalhado pelo seu UUID. Inclui adicionalmente a lista de usuários no campo "users".

Parâmetros

• cli_uuid (obrigatório, string) - UUID do cliente.

Resposta 200 (application/json)

{
  "cli_uuid": "0e92037b-ed77-4a38-ab35-909637bea146",
  "nome": "Client Name",
  "external_client_code": "External Client Code 1",
  "grupo_seguranca": "Partner.Client-AD-Group-Name.9125b66",
  "email_admin": "[e-mail]",
  "has_license_limit": false,
  "license_limit": 0,
  "users": [
    {
      "nome": "Usuario 1",
      "sobrenome": "Um",
      "email": "[e-mail]",
      "ativo": true,
      "username": "e8d3a5bc-32c0-4d57",
      "usr_uuid": "e8d3a5bc-32c0-4d57-8127-d5453b568652",
      "external_ad": false
    },
    {
      "nome": "Usuario 2",
      "sobrenome": "Dois",
      "email": "[e-mail]",
      "ativo": true,
      "username": "e8d3a5bc-32c0-4d57",
      "usr_uuid": "e8d3a5bc-32c0-4d57-8127-d5453b568652",
      "external_ad": false
    }
  ],
  "amb_uuid": "715088c9-9f21-424e-bcd5-5eacc0ce165b",
  "in_maintenance": false,
  "maintenance_msg": "",
  "schedule_maintenance": false,
  "schedule_maintenance_start": null,
  "schedule_maintenance_end": null,
  "schedule_maintenance_msg": "",
  "terminate_sessions": false,
  "schedule_warning": false,
  "schedule_warning_start": null,
  "schedule_warning_end": null,
  "schedule_warning_msg": "",
  "display_warning_to_logged_users": false,
  "user_latest_login_at": null,
  "created_at": "2025-03-13T11:47:45.445637-03:00",
  "updated_at": "2025-03-13T11:47:45.445637-03:00",
  "migrated_at": null,
  "observations": "",
  "active_sessions_count": 0
}

Obter clientes de um ambiente [GET /clients/ambientes/{ambiente_uuid}]

Retorna a listagem de todos os clientes pertencentes a um determinado ambiente.

Parâmetros

• ambiente_uuid (obrigatório, string) - UUID do ambiente de destino.

Resposta 200 (application/json)

(Retorna uma lista de clientes estruturada semelhantemente à rota de listagem geral).

Cadastrar Cliente [POST /clients/]

Realiza o procedimento de cadastramento de um novo cliente na plataforma.

Atributos do Objeto de Entrada (application/json)

• nome (string, obrigatório) - Nome do Cliente na Plataforma.

• external_client_code (string, opcional) - Código customizado do cliente.

• email_admin (string, obrigatório) - E-mail do administrador do ambiente.

• amb_uuid (string, obrigatório) - ID do Ambiente em que o cliente será vinculado.

• description (string, opcional) - Informações adicionais do cliente.

• grupo_seguranca (string, opcional) - Grupo de Segurança do AD que será criado.

• block_multiple_session (boolean, opcional) - Ativa/desativa bloqueio de múltiplas sessões para o mesmo usuário.

• has_license_limit (boolean, opcional) - Indica se o cliente possui limite de licenças de acesso.

• license_limit (number, opcional) - Quantidade limite de licenças de acesso.

• ad_add_aditional_group (string, opcional) - Grupo de segurança do AD para herança/vínculo.

• in_maintenance (boolean, opcional) - Ativa ou desativa a manutenção imediata.

• maintenance_msg (string, opcional) - Mensagem exibida aos usuários em manutenção imediata.

• schedule_maintenance (boolean, obrigatório) - Ativa/desativa manutenção programada por horários.

• schedule_maintenance_start (string) - Data/hora de início da manutenção programada (ISO 8601). Obrigatório se schedule_maintenance for true.

• schedule_maintenance_end (string) - Data/hora de encerramento da manutenção programada (ISO 8601). Obrigatório se schedule_maintenance for true.

• schedule_maintenance_msg (string) - Mensagem apresentada. Obrigatório se schedule_maintenance for true.

• terminate_sessions (boolean, opcional) - Encerra sessões desconectando usuários ativos no início da manutenção programada.

• schedule_warning (boolean, obrigatório) - Ativa/desativa alertas de aviso programados.

• schedule_warning_start (string) - Data/hora de início do aviso (ISO 8601). Obrigatório se schedule_warning for true.

• schedule_warning_end (string) - Data/hora de término do aviso (ISO 8601). Obrigatório se schedule_warning for true.

• schedule_warning_msg (string) - Mensagem do alerta de aviso. Obrigatório se schedule_warning for true.

• display_warning_to_logged_users (boolean) - Garante exibição aos usuários ativos logados. Obrigatório se schedule_warning for true.

• observations (string, opcional) - Observações adicionais sobre o cliente.

Request Body Exemplo

{
  "nome": "Teste Cliente",
  "external_client_code": "External Client Code 1",
  "email_admin": "[e-mail]",
  "amb_uuid": "715088c9-9f21-424e-bcd5-5eacc0ce165b",
  "description": "",
  "grupo_seguranca": "Grupo de segurança",
  "block_multiple_session": false,
  "has_license_limit": false,
  "license_limit": 0,
  "in_maintenance": false,
  "maintenance_msg": "",
  "ad_add_aditional_group": "VersionProd"
}

Resposta 200 (application/json)

{
  "cli_uuid": "79ea8324-4889-4729-8bf0-bc1c40b38273",
  "nome": "MeuCliente001",
  "external_client_code": "External Client Code 1",
  "grupo_seguranca": "Cliente001",
  "email_admin": "[e-mail]",
  "block_multiple_session": false,
  "has_license_limit": false,
  "license_limit": 0,
  "users": [],
  "amb_uuid": "715088c9-9f21-424e-bcd5-5eacc0ce165b",
  "in_maintenance": false,
  "maintenance_msg": "",
  "schedule_maintenance": false,
  "schedule_maintenance_start": null,
  "schedule_maintenance_end": null,
  "schedule_maintenance_msg": "",
  "terminate_sessions": false,
  "schedule_warning": false,
  "schedule_warning_start": null,
  "schedule_warning_end": null,
  "schedule_warning_msg": "",
  "display_warning_to_logged_users": false,
  "user_latest_login_at": null,
  "created_at": "2025-03-13T11:53:05.504255-03:00",
  "updated_at": "2025-03-13T11:53:05.554461-03:00",
  "migrated_at": null,
  "observations": "",
  "active_sessions_count": 0
}

Editar Cliente [PATCH /clients/{cli_uuid}]

Procedimento utilizado para editar as informações cadastrais de um Cliente existente.

Parâmetros

• cli_uuid (obrigatório, string) - UUID do cliente a ser modificado.

Atributos do Request (application/json)

• nome (string) - Nome do Cliente na Plataforma.

• external_client_code (string) - Código customizado do cliente.

• email_admin (string) - Email do Administrador do Ambiente.

• amb_uuid (string) - ID do Ambiente de vinculação.

• description (string) - Informações adicionais do cliente.

• block_multiple_session (boolean) - Ativa ou desativa o bloqueio de múltiplas sessões.

• grupo_seguranca (string) - Grupo de segurança no AD.

• has_license_limit (boolean) - Se há limite de licenças.

• license_limit (number) - Número limite de licenças.

• ad_add_aditional_group (string) - Grupo do AD para associar o grupo do cliente.

• ad_remove_aditional_group (string) - Grupo do AD para desassociar o grupo do cliente.

• observations (string) - Observações adicionais do Cliente.

Request Body Exemplo

{
  "nome": "Teste Cliente",
  "external_client_code": "External Client Code 1",
  "email_admin": "[e-mail]",
  "amb_uuid": "6a6c7a07-bef1-4e42-942e-87277a8c2a84",
  "grupo_seguranca": "Grupo de segurança",
  "block_multiple_session": false,
  "has_license_limit": false,
  "license_limit": 0,
  "ad_add_aditional_group": "VersionProd",
  "in_maintenance": false,
  "maintenance_msg": ""
}

Resposta 200 (application/json)

(Retorna o objeto de cliente atualizado detalhado com sucesso).

Editar clientes de um ambiente específico [PATCH /clients/?amb_uuid={ambiente_uuid}]

Procedimento em lote para editar informações comuns de todos os clientes pertencentes a um ambiente.

Parâmetros

• ambiente_uuid (obrigatório, string) - UUID do ambiente de destino.

Request Body Exemplo

{
  "email_admin": "[e-mail]",
  "amb_uuid": "6a6c7a07-bef1-4e42-942e-87277a8c2a84",
  "grupo_seguranca": "Grupo de segurança",
  "block_multiple_session": false,
  "has_license_limit": false,
  "license_limit": 0,
  "ad_add_aditional_group": "VersionProd",
  "in_maintenance": false,
  "maintenance_msg": ""
}

Resposta 200 (application/json)

{
  "detail": "Clients updated successfully"
}

Remover Cliente [DELETE /clients/{cli_uuid}]

Remove o cadastro de um cliente. A remoção falhará se houverem usuários ativos vinculados.

Parâmetros

• cli_uuid (obrigatório, string) - UUID do cliente a ser removido.

Resposta 200 (application/json)

{
  "status": "success"
}

Resposta 400 (application/json)

{
  "status": "error",
  "code": "CLI001",
  "message": "O Cliente em questão possui usuários vinculados. Realize a exclusão dos Usuários antes para excluir esse Cliente."
}

Bloquear / Desbloquear Cliente [PATCH /clients/{cli_uuid}]

Realiza a manutenção imediata bloqueando ou liberando um cliente específico na plataforma.

Parâmetros

• cli_uuid (obrigatório, string) - UUID do cliente.

Atributos do Request (application/json)

• in_maintenance (boolean, obrigatório) - Define se o cliente está sob manutenção imediata (true/false).

• maintenance_msg (string) - Mensagem a ser exibida aos usuários no momento do bloqueio/login.

Resposta 200 (application/json)

(Retorna o objeto do cliente atualizado com o novo status de manutenção imediata).

Ativar / Desativar a manutenção programada [PATCH /clients/{cli_uuid}]

Define regras de manutenção programada para um cliente específico.

Atributos do Request (application/json)

• schedule_maintenance (boolean, obrigatório) - Ativa ou desativa a programação.

• schedule_maintenance_start (string) - Início da janela de manutenção.

• schedule_maintenance_end (string) - Fim da janela de manutenção.

• schedule_maintenance_msg (string) - Mensagem que será apresentada aos usuários.

• terminate_sessions (boolean) - Força encerramento e desconexão de usuários logados.

Resposta 200 (application/json)

(Retorna o objeto do cliente com os parâmetros de manutenção agendada atualizados).

Ativar / Desativar a manutenção programada em lote [PATCH /clients/batch-scheduled-actions/]

Aplica ações de manutenção programada para múltiplos clientes simultaneamente.

Atributos do Request (application/json)

• cli_uuids (array, obrigatório) - Lista de strings dos UUIDs dos clientes a serem modificados.

• scheduled_data (object) - Detalhes da manutenção programada contendo:

  • schedule_maintenance (boolean, obrigatório)

  • schedule_maintenance_start (string)

  • schedule_maintenance_end (string)

  • schedule_maintenance_msg (string)

  • terminate_sessions (boolean)

Resposta 200 (application/json)

(Retorna a listagem contendo os objetos atualizados dos clientes selecionados).

Ativar / Desativar a exibição programada de avisos [PATCH /clients/{cli_uuid}]

Ativa ou desativa a exibição agendada de mensagens informativas/avisos a um cliente.

Atributos do Request (application/json)

• schedule_warning (boolean, obrigatório) - Ativa ou desativa o alerta de aviso programado.

• schedule_warning_start (string) - Data/hora de início da veiculação.

• schedule_warning_end (string) - Data/hora de encerramento do aviso.

• schedule_warning_msg (string) - Texto do aviso aos usuários.

• display_warning_to_logged_users (boolean) - Se true, exibe também para quem já está logado além de no ato do login.

Resposta 200 (application/json)

(Retorna o objeto de cliente com as definições de aviso configuradas).

Ativar / Desativar a exibição programada de avisos em lote [PATCH /clients/batch-scheduled-actions/]

Aplica de forma simultânea a configuração programada de avisos a múltiplos clientes.

Atributos do Request (application/json)

• cli_uuids (array, obrigatório) - Lista dos UUIDs dos clientes.

• scheduled_data (object) - Objeto contendo os dados de aviso a serem aplicados:

  • schedule_warning (boolean, obrigatório)

  • schedule_warning_start (string)

  • schedule_warning_end (string)

  • schedule_warning_msg (string)

  • display_warning_to_logged_users (boolean)

Resposta 200 (application/json)

(Retorna o estado atualizado dos objetos clientes do lote).

API Servidor de Preparação [/environments/{amb_uuid}/servers/template/]

Chamadas de API para gerenciamento e publicação do servidor de preparação de um ambiente.

Obter dados do servidor de preparação [GET]

Recupera as informações e o estado atual do servidor de preparação.

Parâmetros

• amb_uuid (obrigatório, string) - UUID do ambiente associado.

• force_refresh (boolean, opcional) - Se true, força uma consulta atualizada direta com o provedor de nuvem.

Resposta 200 (application/json)

{
  "instance_id": "ocid1.instance.oc1.sa-saopaulo-1.antxxptoftpxptocmgr2i3t37ruxpto2kof5nh6k5xkrfuupjkyoqbkwxpto",
  "name": "TEMPLATE_SERVER_NAME",
  "instance_state": "RUNNING",  
  "public_ip": "1.2.3.4",
  "private_ip": "4.3.2.1",
  "stop_time": "2021/03/15 19:42:25"
}

Estados possíveis em instance_state: "RUNNING", "STOPPED", "STOPPING", "PENDING", "TERMINATED", "WARNING".

Ligar servidor de preparação [POST /environments/{amb_uuid}/servers/template/start]

Inicia o servidor de preparação do ambiente.

Resposta 204

(Sem corpo de retorno - Processado com sucesso).

Desligar servidor de preparação [POST /environments/{amb_uuid}/servers/template/stop]

Desliga o servidor de preparação do ambiente de modelo.

Resposta 204

(Sem corpo de retorno).

Publicar uma imagem padrão [POST /environments/{amb_uuid}/servers/template/publish/]

Inicia o fluxo para a publicação padrão (default) da máquina de preparação do ambiente.

Resposta 202 (application/json)

{
  "status": 202,
  "message": "Publicacao iniciada com sucesso.",
  "request_id": "149cbd70-5241-4e62-88a7-c87bcdf2eecc"
}

Status de publicação de imagem [GET /environments/{amb_uuid}/servers/template/publish/{request_id}]

Verifica o andamento de uma requisição de publicação de imagem padrão por seu ID de requisição.

Resposta 200 (application/json)

{
  "status": 200,
  "image_publication_status": "PUBLISHING",
  "message": "Publicação em andamento."
}

Valores possíveis em image_publication_status: "PUBLISHING", "PUBLISHED", "ERROR".

API Servidor de Preparação Otimizada [/environments/{amb_uuid}/servers/template/optimized-publish/]

Operações avançadas de publicação de imagens e instâncias de ambiente.

Publicar uma imagem de forma otimizada - Padrão [POST]

Gera a publicação otimizada sem bloquear as instâncias antigas em execução (block_instances configurado como false).

Atributos do Request (application/json)

• stop_server (boolean) - Define se o servidor de preparação deve ser desligado para criar a imagem (false o mantém disponível).

• notify_list (array) - Lista de e-mails para envio de notificação ao concluir o processo.

• replace_instances (object) - Propriedades de substituição:

  • block_instances (boolean) - Define se bloqueia as instâncias na versão anterior da imagem (aqui false).

Request Body Exemplo

{
  "stop_server": false,
  "notify_list": [
    "[e-mail]",
    "[e-mail]"
  ],
  "replace_instances": {
    "block_instances": false
  }
}

Resposta 202 (application/json)

{
  "status": 202,
  "message": "Publicacao iniciada com sucesso.",
  "request_id": "149cbd70-5241-4e62-88a7-c87bcdf2eecc"
}

Publicar uma imagem de forma otimizada - Bloquear instâncias antigas [POST]

Inicia o processo de publicação com o bloqueio obrigatório das instâncias anteriores em execução (block_instances configurado como true).

Atributos do Request (application/json)

• stop_server (boolean) - Estado do servidor de preparação durante a imagem.

• notify_list (array) - E-mails notificados no sucesso.

• replace_instances (object) - Configurações detalhadas:

  • block_instances (boolean) - Deve ser true.

  • blocked_ttl_minutes (number, opcional) - Tempo de expiração em minutos para encerramento após o bloqueio. Valores suportados: 5, 15, 30, 60. Padrão: 30.

  • notify_users (boolean, opcional) - Se true, avisa imediatamente usuários conectados sobre a contagem regressiva para expirar.

  • instance_block_user_message (string, opcional) - Texto do aviso enviado no bloqueio.

Request Body Exemplo

{
  "stop_server": false,
  "notify_list": [
    "[e-mail]",
    "[e-mail]"
  ],
  "replace_instances": {
    "block_instances": true,
    "instance_block_user_message": "Manutenção: salve seu trabalho."
  }
}

Resposta 202 (application/json)

(Semelhante ao retorno padrão de processamento aceito).

Publicar uma imagem de forma otimizada - Parar servidor de preparação ao criar imagem [POST]

Executa o fluxo configurando explicitamente stop_server como true, indisponibilizando o template durante o ciclo de publicação.

Request Body Exemplo

{
  "stop_server": true,
  "notify_list": [
    "[e-mail]",
    "[e-mail]"
  ],
  "replace_instances": {
    "block_instances": false
  }
}

Resposta 202 (application/json)

(Retorna o ID da publicação aceita em processamento).

Verificar status de publicação de imagem [GET /environments/{amb_uuid}/servers/template/optimized-publish/{request_id}/]

Verifica a situação da requisição para o fluxo de publicação otimizada.

Resposta 200 (application/json)

{
  "status": 200,
  "image_publication_status": "PUBLISHING",
  "message": "Publicação em andamento."
}

API Clientes de um Ambiente [/clients/ambientes/{amb_uuid}]

Listar Clientes no Ambiente [GET]

Retorna de forma direta as informações detalhadas e usuários vinculados de todos os clientes em um ambiente desejado.

Resposta 200 (application/json)

[
  {
    "cli_uuid": "0e92037b-ed77-4a38-ab35-909637bea146",
    "nome": "Client Name",
    "grupo_seguranca": "Partner.Client-AD-Group-Name.9125b66",
    "email_admin": "[e-mail]",
    "has_license_limit": false,
    "license_limit": 0,
    "users": [
      {
        "nome": "Usuario 1",
        "sobrenome": "Um",
        "email": "[e-mail]",
        "ativo": true,
        "username": "e8d3a5bc-32c0-4d57",
        "usr_uuid": "e8d3a5bc-32c0-4d57-8127-d5453b568652",
        "external_ad": false
      }
    ],
    "amb_uuid": "715088c9-9f21-424e-bcd5-5eacc0ce165b",
    "in_maintenance": false,
    "maintenance_msg": "",
    "schedule_maintenance": false,
    "schedule_maintenance_start": null,
    "schedule_maintenance_end": null,
    "schedule_maintenance_msg": "",
    "terminate_sessions": false,
    "schedule_warning": false,
    "schedule_warning_start": null,
    "schedule_warning_end": null,
    "schedule_warning_msg": "",
    "display_warning_to_logged_users": false
  }
]

API Ambientes [/environments/]

Ações de controle para ambientes completos.

Listar Ambientes [GET]

Consulta geral de todos os ambientes cadastrados no sistema.

Resposta 200 (application/json)

[
  {
    "amb_uuid": "dd2f7c4e-8dee-4ecc-8033-f21207945d55",
    "nome": "Ambiente 1",
    "in_maintenance": false,
    "maintenance_msg": "Em manutenção",
    "schedule_maintenance": false,
    "schedule_maintenance_start": "2020-12-11T03:10:14-03:00",
    "schedule_maintenance_end": "2020-12-12T07:35:15-03:00",
    "schedule_maintenance_msg": "Em manutenção",
    "terminate_sessions": false,
    "terminate_instances": false,
    "schedule_warning": false,
    "schedule_warning_start": "2020-12-24T00:00:00-03:00",
    "schedule_warning_end": "2020-12-25T00:00:00-03:00",
    "schedule_warning_msg": "Feliz Natal!",
    "display_warning_to_logged_users": false,
    "environment_state": "available",
    "preparation_server": {
      "instance_id": "ocid1.instance.oc1.sa-saopaulo-1.antxxptoftpxptocmgr2i3t37ruxpto2kof5nh6k5xkrfuupjkyoqbkwxpto",
      "name": "TEMPLATE_SERVER_NAME",
      "public_ip": "1.2.3.4",
      "private_ip": "4.3.2.1",
      "instance_state": "RUNNING",
      "stop_time": "2021/03/15 19:42:25"
    }
  },
  {
    "amb_uuid": "715088c9-9f21-424e-bcd5-5eacc0ce165b",
    "nome": "Ambiente 2",
    "in_maintenance": false,
    "maintenance_msg": "",
    "schedule_maintenance": false,
    "schedule_maintenance_start": null,
    "schedule_maintenance_end": null,
    "schedule_maintenance_msg": "",
    "terminate_sessions": false,
    "terminate_instances": false,
    "schedule_warning": false,
    "schedule_warning_start": null,
    "schedule_warning_end": null,
    "schedule_warning_msg": "",
    "display_warning_to_logged_users": false,
    "environment_state": "available",
    "preparation_server": null
  }
]

Obter dados de um ambiente [GET /environments/{amb_uuid}]

Retorna as propriedades detalhadas de um ambiente específico.

Resposta 200 (application/json)

(Semelhante aos objetos de resposta detalhados da listagem).

Ativar / Desativar a manutenção imediata [PATCH /environments/{amb_uuid}]

Aplica bloqueio por manutenção de forma global em todo o ambiente de forma imediata.

Atributos do Request (application/json)

• in_maintenance (boolean, obrigatório) - true para colocar em manutenção imediata, false para liberar.

• maintenance_msg (string) - Descrição do aviso exibido aos usuários finais.

Resposta 200 (application/json)

{
  "amb_uuid": "715088c9-9f21-424e-bcd5-5eacc0ce165b",
  "nome": "Ambiente 2",
  "in_maintenance": true,
  "maintenance_msg": "Em manutenção",
  "schedule_maintenance": false,
  "schedule_maintenance_start": null,
  "schedule_maintenance_end": null,
  "schedule_maintenance_msg": "",
  "terminate_sessions": false,
  "terminate_instances": false,
  "schedule_warning": false,
  "schedule_warning_start": null,
  "schedule_warning_end": null,
  "schedule_warning_msg": "",
  "display_warning_to_logged_users": false
}

Ativar / Desativar a manutenção programada [PATCH /environments/{amb_uuid}]

Programa e configura uma janela para bloqueio por manutenção técnica para todo o ambiente.

Atributos do Request (application/json)

• schedule_maintenance (boolean, obrigatório)

• schedule_maintenance_start (string)

• schedule_maintenance_end (string)

• schedule_maintenance_msg (string)

• terminate_sessions (boolean) - Encerra sessões ativas dos usuários.

• terminate_instances (boolean) - Derruba e encerra de vez as instâncias ligadas no ambiente.

Resposta 200 (application/json)

{
  "amb_uuid": "715088c9-9f21-424e-bcd5-5eacc0ce165b",
  "nome": "Ambiente 2",
  "in_maintenance": true,
  "maintenance_msg": "Em manutenção",
  "schedule_maintenance": true,
  "schedule_maintenance_start": "2020-12-11T03:10:14-03:00",
  "schedule_maintenance_end": "2020-12-12T07:35:15-03:00",
  "schedule_maintenance_msg": "Em manutenção",
  "terminate_sessions": false,
  "terminate_instances": false,
  "schedule_warning": false,
  "schedule_warning_start": null,
  "schedule_warning_end": null,
  "schedule_warning_msg": "",
  "display_warning_to_logged_users": false
}

Ativar / Desativar a exibição programada de avisos [PATCH /environments/{amb_uuid}]

Permite o agendamento de avisos ao nível do ambiente global.

Atributos do Request (application/json)

• schedule_warning (boolean, obrigatório)

• schedule_warning_start (string)

• schedule_warning_end (string)

• schedule_warning_msg (string)

• display_warning_to_logged_users (boolean)

Resposta 200 (application/json)

{
  "amb_uuid": "715088c9-9f21-424e-bcd5-5eacc0ce165b",
  "nome": "Ambiente 2",
  "in_maintenance": false,
  "maintenance_msg": "",
  "schedule_maintenance": false,
  "schedule_maintenance_start": null,
  "schedule_maintenance_end": null,
  "schedule_maintenance_msg": "",
  "terminate_sessions": false,
  "terminate_instances": false,
  "schedule_warning": true,
  "schedule_warning_start": "2020-12-24T00:00:00-03:00",
  "schedule_warning_end": "2020-12-25T00:00:00-03:00",
  "schedule_warning_msg": "Feliz Natal!",
  "display_warning_to_logged_users": false
}

API Migração de clientes [/migrate/clients/]

Migrar Clientes [POST]

Modifica e transfere o ambiente de destino de uma listagem informada de clientes.

Atributos do Request (application/json)

• cli_list (array, obrigatório) - Lista de strings contendo os UUIDs de clientes a migrar.

• amb_uuid (string, obrigatório) - UUID do ambiente de destino para onde os clientes serão movidos.

Resposta 200 (application/json)

{
  "status": "success"
}

API Usuários [/users/{?cli_uuid}]

Operações de gerenciamento para o ciclo de vida dos usuários.

Listar Usuários [GET]

Retorna a lista de usuários registrados.

Parâmetros

• cli_uuid (opcional, string) - Permite retornar somente usuários pertencentes a um cliente específico.

Resposta 200 (application/json)

[
  {
    "nome": "João",
    "sobrenome": "Souza",
    "email": "[e-mail]",
    "ativo": true,
    "username": "joao.souza",
    "usr_uuid": "3bc705ab-5536-4193-bd5c-2d3e8ffd2e5b",
    "external_ad": false
  }
]

Obter dados de um usuário [GET /users/{usr_uuid}]

Retorna as informações completas de um usuário e os clientes em que está associado.

Parâmetros

• usr_uuid (obrigatório, string) - Identificador único do usuário.

Resposta 200 (application/json)

[
  {
    "nome": "João",
    "sobrenome": "Souza",
    "email": "[e-mail]",
    "ativo": true,
    "username": "joao.souza",
    "usr_uuid": "3bc705ab-5536-4193-bd5c-2d3e8ffd2e5b",
    "clients": [
      {
        "cli_uuid": "79ea8324-4889-4729-8bf0-bc1c40b38273",
        "nome": "MeuCliente001",
        "grupo_seguranca": "Cliente001",
        "email_admin": "[e-mail]",
        "has_license_limit": false,
        "license_limit": 0,
        "users": [],
        "amb_uuid": "715088c9-9f21-424e-bcd5-5eacc0ce165b",
        "in_maintenance": false,
        "maintenance_msg": "",
        "schedule_maintenance": false,
        "schedule_maintenance_start": null,
        "schedule_maintenance_end": null,
        "schedule_maintenance_msg": "",
        "terminate_sessions": false,
        "schedule_warning": true,
        "schedule_warning_start": "2021-12-01T23:10:00.000-03:00",
        "schedule_warning_end": "2021-12-31T22:30:00.000-03:00",
        "schedule_warning_msg": "Mensagem de Aviso aos Usuários",
        "display_warning_to_logged_users": true
      }
    ],
    "external_ad": false
  }
]

Cadastrar Usuário [POST /users/]

Cadastra um usuário ou vincula-o a outro cliente se ele já existir na base.

Atributos do Request (application/json)

• nome (string, obrigatório)

• sobrenome (string, opcional)

• email (string, obrigatório) - E-mail de logon do usuário.

• ativo (boolean, opcional) - true/false.

• username (string, opcional) - Nome do Usuário no Active Directory (AD).

• password (string) - Senha de acesso.

• cli_uuid (string, obrigatório) - UUID do cliente ao qual ele está sendo vinculado primariamente.

• description (string, opcional) - Dados complementares.

• fullname (string, opcional) - Nome completo (pelo menos duas palavras separadas por espaço).

• external_ad (boolean) - Deve ser true caso utilize AD próprio integrado.

• send_activation_email (boolean, opcional) - Determina se envia e-mail automático de boas-vindas/ativação.

Request Body Exemplo

{
  "nome": "Joao",
  "sobrenome": "Souza",
  "email": "[e-mail]",
  "ativo": true,
  "username": "joao.souza",
  "password": "senha123",
  "cli_uuid": "769a0f4e-16a8-422a-99ab-d8c416137d4c",
  "description": "Informações do Usuário XXXX",
  "fullname": "Joao Souza Matrins",
  "external_ad": false,
  "send_activation_email": false
}

Resposta 200 (application/json)

{
  "nome": "Joao",
  "sobrenome": "Souza",
  "email": "[e-mail]",
  "ativo": true,
  "username": "joao.souza",
  "usr_uuid": "3bc705ab-5536-4193-bd5c-2d3e8ffd2e5b",
  "clients": [],
  "external_ad": true
}

Editar Usuário [PUT /users/{usr_uuid}]

Atualiza dados cadastrais permitidos do usuário.

Atributos do Request (application/json)

• nome (string)

• sobrenome (string)

• ativo (boolean)

• password (string)

• description (string)

Request Body Exemplo

{
  "nome": "Joao",
  "sobrenome": "Souza",
  "ativo": true,
  "password": "senha123"
}

Resposta 200 (application/json)

(Retorna o objeto de usuário completo atualizado).

Ativar / Desativar Usuário [PATCH /users/{usr_uuid}]

Altera a propriedade ativo e/ou gerencia o reenvio do e-mail de ativação.

Atributos do Request (application/json)

• ativo (boolean) - Novo estado de ativação.

• send_activation_email (boolean, opcional)

• cli_uuid (string, opcional)

Resposta 200 (application/json)

{
  "nome": "João",
  "sobrenome": "Souza",
  "email": "[e-mail]",
  "ativo": true,
  "username": "joao.souza",
  "cli_uuid": "769a0f4e-16a8-422a-99ab-d8c416137d4c"
}

Alterar Senha Usuário [PATCH /users/{usr_uuid}]

Modifica e sincroniza a senha do usuário diretamente no AD de destino.

Atributos do Request (application/json)

• password (string, obrigatório) - Nova senha do usuário.

Request Body Exemplo

{
  "password": "NibiruIsComming@2023!"
}

Resposta 200 (application/json)

{
  "status": "success"
}

Remover Usuário [DELETE /users/{usr_uuid}]

Exclui um usuário da plataforma de vez.

Resposta 200 (application/json)

{
  "status": "success"
}

Resposta 404 (application/json)

{
  "status": "error",
  "detail": "Não encontrado"
}

API Aplicações [/apps/{?cli_uuid}]

Métodos para controle granular de publicações de programas e aplicativos.

Nota: Não é obrigatório o uso desta API caso as permissões e exibições sejam tratadas diretamente via políticas internas na imagem template do servidor de preparação. Por padrão, novas aplicações são registradas como INATIVA.

Listar Aplicações [GET]

Lista todos os programas cadastrados.

Parâmetros

• cli_uuid (opcional, string) - Filtra aplicações associadas a um determinado cliente.

Resposta 200 (application/json)

[
  {
    "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 [GET /apps/{app_uuid}]

Retorna as informações completas da aplicação incluindo os dados de cliente associado.

Resposta 200 (application/json)

(Retorna uma listagem detalhada correspondente com o detalhe do objeto "cliente").

Cadastrar Aplicação [POST /apps/]

Cadastra uma nova aplicação.

Atributos do Request (application/json)

• nome (string, obrigatório)

• cli_uuid (string, obrigatório)

• estado (string, obrigatório) - "ATIVO" ou "INATIVO".

• endereco_app (string, opcional) - Caminho absoluto executável na instância.

• parametro_app (string, opcional) - Argumentos adicionais de inicialização.

Request Body Exemplo

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

Resposta 200 (application/json)

{
  "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 [PUT /apps/{app_uuid}]

Edita as configurações do executável do aplicativo.

Request Body Exemplo

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

Resposta 200 (application/json)

(Retorna o objeto da aplicação editada com sucesso).

Remover Aplicação [DELETE /apps/{app_uuid}]

Exclui de vez o registro do aplicativo.

Resposta 200 (application/json)

{
  "status": "success"
}

API Sessões [/sessions/{?cli_uuid}]

Métodos para controle, monitoramento e gerenciamento de conexões de usuários.

Listar Sessões [GET]

Verifica as conexões e instâncias ativas na plataforma.

Parâmetros

• cli_uuid (opcional, string) - Retorna apenas sessões ligadas a um cliente específico.

Resposta 200 (application/json)

[
  {
    "ssid": "9cfb4863",
    "client": {},
    "user": {},
    "instance": {},
    "creation_date": "2017-10-02T18:35:14.470434Z",
    "termination_date": null,
    "termination_reason": "",
    "status": "ativa",
    "my_ip": "99.99.99.99"
  }
]

Obter dados de uma sessão [GET /sessions/{ssid}]

Verifica os metadados de conexões em tempo real baseando-se no ID SSID da sessão.

Resposta 200 (application/json)

(Retorna dados detalhados da sessão correspondente).

Remover Sessão [DELETE /sessions/{ssid}]

Desconecta o usuário enviando uma contagem regressiva e forçando o encerramento compulsório caso o usuário persista conectado após o encerramento do temporizador.

Atributos do Request (application/json)

• time (number, obrigatório) - Tempo limite em minutos concedido antes de desligar a sessão por completo.

• message (string) - Texto descritivo de aviso de encerramento enviado aos usuários finais.

Resposta 200 (application/json)

{
  "status": "success"
}

API Autenticação [/login/]

Autenticar Usuário [POST]

Utilizado exclusivamente para validar credenciais no ato de fluxos de redirect.

Importante: Esta rota não gera o token de sessão final persistente e seguro na plataforma de logon. O fluxo real de logon operacional do usuário deve utilizar as chamadas diretas com base no tópico seguinte.

Request Body Exemplo

{
  "email": "[e-mail]",
  "password": "minhasenha"
}

Resposta 200 (application/json)

{
  "status": "Success",
  "msg": "User auth with success!"
}

Group Logon Plataforma

Sobre

O fluxo de logon operacional da plataforma é realizado via redirecionamento de requisição HTTPS para o portal, parametrizando dados de forma direta para que plugins e rotinas nativas de conexão da nuvem Autosky iniciem sua validação de forma integrada.

Estrutura de Chamada URL

O ponto de entrada de logon é formado pelo host principal concatenado com o parâmetro auth, além de configurações opcionais.

Parâmetros

• auth (obrigatório) - Informações no formato EMAIL:SENHA codificadas em string formato BASE64.

• param (opcional) - Parâmetros internos do aplicativo codificados em formato BASE64.

• back_url (opcional) - Endereço completo URL de retorno (envio em TEXTO PLANO / NORMAL).

Exemplo (Antes da Conversão Base64):

https://meudominio.skyinone.net/usuario/autentica/?auth=[e-mail]:MinhaSenha&param=123456789&back_url=https://www.meu-portal-acesso.com.br

Exemplo Real (Após Conversão Base64):

https://meudominio.skyinone.net/usuario/autentica/?auth=bWV1ZW1haWxAZG9taW5pby5jb206TWluaGFTZW5oYQ==&param=MTIzNDU2Nzg5&back_url=https://www.meu-portal-acesso.com.br

Group Outras Informações

Segurança e Controle de IP

Para maior proteção contra sequestro ou roubo de tokens de autorização de API, é fornecido suporte opcional à filtragem de endereços IP de origem.

Apenas servidores autorizados cadastrados terão acesso às chamadas de rota. A ativação desse recurso deve ser efetuada via abertura de ticket junto à equipe de suporte técnico da Skyone.

A tentativa de requisição usando origem ou IP não permitido resultará em:

• HTTP Status: 403 - FORBIDDEN

• JSON de Erro: {"detail": "Invalid token."}

Mensagens de Retorno da API (Códigos de Erro)

Listagem de mensagens comuns de erro retornadas no cabeçalho interno das transações de resposta:

Ambientes

• ENV001: Erro ao salvar alterações.

• ENV002: Erro ao registrar manutenção programada.

• ENV003: Erro ao desativar as manutenções programadas.

• ENV004: Erro ao registrar exibição de avisos.

Clientes

• CLI001: Erro ao salvar cliente no banco.

• CLI002: Erro ao criar grupo de segurança no AD.

• CLI003: Erro ao atualizar permissões.

• CLI004: Erro ao salvar alterações.

• CLI005: Erro ao remover cliente: existem usuários ativos vinculados.

• CLI006: Erro ao remover grupo de segurança do AD.

• CLI007: Nome de cliente já está em uso.

• CLI008: Erro ao registrar manutenção programada.

• CLI009: Erro ao desativar as manutenções programadas.

• CLI010: Erro ao registrar exibição de avisos.

Usuários

• USR001: Erro ao alterar/configurar senha do usuário.

• USR002: Cliente não encontrado.

• USR003: Erro ao adicionar usuário ao grupo.

• USR004: Usuário já adicionado ao cliente selecionado.

• USR005: Erro de comunicação com o servidor Active Directory.

• USR006: Por favor, informe um cliente válido (cli_uuid).

• USR007: Erro ao salvar usuário no banco de dados.

• USR008: Erro ao remover usuário do banco de dados (DB).

• USR009: Erro ao remover usuário do Active Directory.

• USR010: Erro ao desvincular usuário do cliente.

• USR011: Erro ao adicionar usuário externo: Username é obrigatório.

• USR012: Erro ao adicionar usuário externo: O parâmetro Password não é permitido para autenticação via AD externo.

• USR013: Por favor, informe um usuário válido (usr_uuid).

Aplicativos

• APP001: Cliente não encontrado.

• APP002: Erro ao salvar aplicação no banco de dados.

• APP003: Aplicação não encontrada.