API SIEM

Updated: May 21, 2026

A API SIEM expõe eventos de auditoria do Workspace como um feed JSON paginado, compatível com o padrão CEF (Common Event Format). Use-o para ingerir logs de auditoria do Altium 365 em seu sistema SIEM (Gerenciamento de eventos e informações de segurança) ou em qualquer ferramenta de conformidade externa.

Enterprise license required. A opção Exportação de auditoria só aparece nas configurações do Workspace Admin quando uma licença de nível empresarial está ativa.

Localizando seu ponto de extremidade e credenciais

Cada espaço de trabalho tem seu próprio URL e credenciais de ponto de extremidade de auditoria. Para encontrá-los:

Aceda a Admin → Settings → Audit Export no seu espaço de trabalho.
Copie o Endpoint URL, Client ID, e Secret Key.

Pode gerar novamente ou revogar a chave secreta a partir desta página em qualquer altura. A regeneração de uma chave invalida imediatamente a anterior.

Autenticação

Cada pedido requer dois cabeçalhos personalizados:

Header	Value
`ClientId`	Seu ID de cliente do Workspace
`ClientSecret`	A sua chave secreta do espaço de trabalho

Obtenção de eventos

GET {your-audit-endpoint}?Offset=0&Limit=500
ClientId: {seu-cliente-id}
ClientSecret: {seu-secret-key}

Parâmetros da consulta

Parâmetro	Necessário	Descrição
`Offset`	Não	Posição inicial no conjunto de resultados. Predefinição: `0`
`Limit`	Não	Número máximo de eventos a devolver. Não pode exceder o máximo da API; se o exceder, devolve `400`.

Exemplo Curl

curl -G '{your-audit-endpoint}' \
  -H 'ClientId: {seu-cliente-id}' \
  -H 'ClientSecret: {sua chave secreta}' \
  --data-urlencode 'Offset=0' \
  --data-urlencode 'Limit=500'

Formato da resposta

{
  "TotalCount": 2,
  "Eventos": [
    {
      "CefVersion": "1",
      "DeviceVendor": "Altium",
      "DeviceProduct": "Plataforma 365",
      "DeviceVersion": "Cloud",
      "DeviceEventClassId": "",
      "Nome": "Login do utilizador",
      "Extensão": {
        "dvchost": "host.domain.com",
        "msg": "Início de sessão bem sucedido do utilizador",
        "rt": "2024-01-10T14:30:00Z",
        "dtz": "UTC+00:00",
        "suser": "sampleuser",
        "act": "login",
        "externalId": "45678",
        "cat": "authentication"
      }
    }
  ]
}

Campos de nível superior

Campo	Tipo de campo	Descrição
`TotalCount`	número inteiro	Número total de eventos disponíveis em todas as páginas
`Events`	matriz	Eventos na página atual

Campos de eventos

Campo	Tipo de evento	Descrição do campo
`CefVersion`	cadeia	Versão CEF
`DeviceVendor`	cadeia	Sempre `"Altium"`
`DeviceProduct`	cadeia	Sempre `"365 Platform"`
`DeviceVersion`	cadeia	Sempre `"Cloud"`
`DeviceEventClassId`	cadeia	Identificador de classe de evento
`Name`	cadeia	Nome do evento legível por humanos (por exemplo `"User Login"`)
`Extension`	objeto	Dados pormenorizados do evento - ver abaixo

Campos da extensão

Campo	Tipo de campo	Descrição do campo
`dvchost`	cadeia	Nome de domínio totalmente qualificado do espaço de trabalho
`msg`	cadeia de caracteres	Descrição do evento legível por humanos
`rt`	cadeia de caracteres	Carimbo de data/hora do evento (ISO 8601)
`dtz`	cadeia	Fuso horário (por exemplo `"UTC+00:00"`)
`suser`	string	Nome de utilizador associado ao evento
`act`	string	Ação realizada (por exemplo `"login"`, `"create"`, `"delete"`)
`externalId`	cadeia	ID da entidade de origem
`cat`	cadeia	Categoria do evento (por exemplo `"authentication"`, `"design"`)

Paginação

Utiliza TotalCount da primeira resposta para determinar quantas páginas devem ser buscadas. Incrementar Offset pelo seu Limit em cada solicitação subsequente até que todos os eventos sejam recuperados.

Página 1: Desvio=0, Limite=500 → eventos 1-500
Página 2: Desvio=500, Limite=500 → eventos 501-1000
...

Códigos de estado HTTP

Código de estado	Significado
`200 OK`	Eventos devolvidos com sucesso
`400 Bad Request`	`Limit` excede o máximo da API
`401 Unauthorized`	Credenciais inválidas ou licença Enterprise não ativa

Leitura adicional

Exportação de auditoria no Altium 365 - Instalação e configuração do administrador do espaço de trabalho.

Versão para impressão

Localizado por IA

Caso encontre um problema, selecione o texto/imagem e primaCtrl + Enterpara nos enviar o seu feedback.