Syxsense API

Como parte do Syxsense Secure, nós fornecemos acessos para dar um push ou pull em informações para e a partir do console do Syxsense. Esta API foi construída para um fácil uso e funcionalidade. Para este fim, definir autenticações para a API e fazendo chamadas para a API são todos processos simples. O que segue é um guia completo para configurar o acesso ao API e gerar chamadas para a API.

Informação Útil

Para uma lista completa de comando disponíveis para API, tal qual sua documentação, clique aqui.

Pré-requisitos

Um usuário com direitos de Admin

Walk-Through Guiado: Como definir o Token API

Primeiro, para acessar a API, o usuário atual do Syxsense precisará ter permissões de administrador no Console. Uma vez que o usuário obtiver o papel administrativo no console, a conta será elegível para o acesso da API. Próximo, o usuário precisará ter um token de acesso gerado API (API Access Token).

❶	Inicie clicando no ícone do usuário no canto superior direito do console Syxsense.
❷	Depois, selecione o link para 'API Access Tokens (PREVIEW)'.
❸	Uma vez ativado o link da API, o console mostrará uma nova tela com todas os tokens da API atuais associados com a atual conta de usuário, juntamente com uma opção de criar um token API. Selecione o botão ‘New Token’ nesta tela.
❹	A partir da janela correspondente de novo token, crie um nome para o token API, ajuste uma data para expirar, adicione uma trava de endereços de IP opcional, e selecione o nível requerido de acesso do console necessário para este token API. Para esse exemplo, nós selecionamos somente o contexto do dispositivo. Dependendo do nível de acesso fornecido para este token, diferentes comandos estarão disponíveis para execução com a API. Assim que o nível desejado de acesso estiver sido imputado para esse token API, clique no botão de ‘Save’ no canto superior esquerdo do painel de permissões. O token API pode levar alguns momentos para ser gerado. Depois de o token ser gerado, uma nova tela surgirá rapidamente, permite que a chave token API para ser gravada. A chave nunca será mostrada novamente, e se a chave for perdida, um novo token precisará ser gerada.
❺	Depois de gravar a chave do token, fecha o prompt e retorna para o API. O novo token se mostrará na lista de tokens atuais, como mostrado abaixo.

Walk-Thought Guiado: Como testas suas API

API permite acessas os dados console usando scritps customizados sem a necessidade de logar no console Syxsense. Você poderá usar esta função para criar relatórios customizados com parâmetros c, não pré-definidos nos relatórios do Syxsense, extraindo os dados necessários e inserindo-os no Microsoft Power BI. Pode também usar API para adicionar campos customizados para o inventário de vários dispositivos no console Syxsense em minutos, executando scripts customizados.

❶	Abra Syxsense API em uma janela do navegador
❷	Clique em no canto superior direito > Insira sua chave no campo de valores Importante: Você pode gerar no Bearer apiKey selecionando em 'Setting'
❸	Role para baixo, para a sessão ‘Computer’.
❹	Clique em 'Get’
❺	Clique em 'Try it Out'
❻	Role para baixo, você verá os possíveis parâmetros para a API. Esta sessão automaticamente atualiza com todos os novos parâmetros conforme vamos adicionando.  Exemplos para iniciar: columnSet: Use qualquer conjunto de colunas existentes no Syxsense Secure para extrair exatamente os campos que deseja. Se você não especificar um conjunto de colunas aqui, Syxsense usará o padrão. QueryName ou QueryID irá puxar os dispositivos que coincide com o critério da query. Use o nome da query como definido no console da Syxsense. GroupName: Puxe somente os dispositivos de um grupo específico. SiteName: Puxe um site específico. Search: Insira o nome de qualquer dispositivo para puxar somente a informação do dispositivo.
❼	Clique no botão de , se você não tiver inserido nenhum critério, este puxará todos os dispositivos do painel do seu computador em um formato de página, uma página de 100 dispositivos por vez (Controlado por parâmetros de página e tamanho de página).
❽	Após o carregamento você verá Curl Request URL Server Response
❾	Dados de resposta do servidor Na parte inferior do corpo de respostas, você poderá ver a contagem das gravações extraídas, o tamanho da página, e a contagem total das páginas. Para ver a segunda página dos dados, mude o parâmetro para '2'.
❿	Você pode modificar os parâmetros para trazer datasets customizados a partir da API.
⓫	O Curl e requisições URL são automaticamente atualizadas com os parâmetros apropriados, e pode ser copiado para sua área de transferência com o ícone e passado para seus programas escolhidos.

Walk-Through Guiado: Como Criar Chamadas API

Antes que as chamadas customizadas fossem fornecidas, o site da API precisa ser autorizado usando a chave de Token gerada durante o processo de criação do Token.

❶	Para autorizar o site da API para fazer chamadas a partir do console da Syxsense correto e com as permissões também corretas, selecione o botão de ‘Authorize’ no API website.
❷	A partir do menu de autorização, cole na chave de token e depois clique em autorizar.
❸	Uma vez autorizada, o site API permitirá chamadas para ser feita para e a partir do fornecedor. Um API autorizado se mostrará abaixo. Uma vez que a autorização for verificada, feche a janela.
❹	Agora que a API foi autorizada, sinta-se livre para tentar quaisquer das chamadas de API disponíveis listadas na ferramenta de configuração da API. Cada chamada de API pode ser modificada para incluir parâmetros relacionados as queries que tenham sido geradas no console Syxsense. Isto permitirá chamadas alvo especificar sessões do ambiente gerenciadas pelo Syxsense.
❺	Clicando no botão ‘Try it out’ providenciará uma saída no formato curl, juntamente com uma opção de renderizar o que os resultados irão se parecerem se a API for chamada diretamente no atual console do Syxsense. Clique no botão ‘Execute’ para ver o resultado da API chamada, exibida no formato JSON junto com a syntax do comando curl que é gerado com a chamada no API.

Discovery: Integrando o Syxsense API com Serviços Externos

Usando a chave do token API e a API correspondente da instrução abaixo, criar chamadas customizadas de API é um processo simples. Nós geramos todas as nossas chamadas de API dos usuários executando os serviços curl, mas é um processo simples para traduzir estas chamadas API para outros serviços. Abaixo segue um exemplo de uma chamada de API do syxsense gerada a partir do Ruby

require 'net/http'

require 'uri'

uri = URI.parse("https://api.syxsense.io/api/Computers?")

request = Net::HTTP::Get.new(uri)

request["Accept"] = "*/*"

request["Authorization"] = "Redacted"

req_options = {

  use_ssl: uri.scheme == "https",

}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|

  http.request(request)

end

puts response.body