DocumentaciónAjuda

API de conteúdo

Leia os artigos publicados de um espaço em JSON com uma chave ul_ct_ e mostre-os no seu site ou na sua aplicação com seu próprio design.

Nesta página

A API de conteúdo entrega os artigos publicados de um espaço de Conhecimento em JSON, para que seu site ou sua aplicação os mostre com o próprio design. É a alternativa à central de ajuda do Elion ITSM quando você quer sua própria página de ajuda.

Antes de começar

  • Você precisa do nível de administrador em Configurações (função Administrador).

  • O espaço com as páginas publicadas deve existir.

Escolher o tipo de chave

Tipo

Para quê

O que pode ler

Navegador (site público do cliente)

O JavaScript do seu site chama a API diretamente.

Só um espaço Pública, e só a partir dos Sites permitidos que você indicar.

Servidor (também páginas internas)

Seu servidor chama a API e entrega o conteúdo à sua aplicação.

Qualquer espaço não arquivado, inclusive Interno ou Portal. É rejeitada se usada a partir de um navegador.

Uma chave de Servidor pode ler páginas internas. Guarde-a como segredo no seu servidor; nunca a coloque no código de uma página web nem em um app móvel.

Criar uma chave

  1. Entre em Configurações → Central de ajuda e abra a aba Importação.

  2. No cartão API de conteúdo, escolha o Espaço e clique em Criar chave.

  3. Preencha Nome, Tipo, Sites permitidos (obrigatório para Navegador, por exemplo https://www.miempresa.cl) e Vence (Em 90 dias, Em 180 dias, Em um ano ou Sem vencimento).

  4. Clique em Criar chave, copie a chave com Copiar chave e clique em Pronto, já copiei.

A chave é mostrada uma única vez. Na tabela você pode Rotacionar uma chave (a nova herda tudo e a anterior continua valendo por 24 horas) ou Revogar uma chave (ela deixa de valer na hora). Cada espaço aceita até 10 chaves vigentes.

Pedir o conteúdo

Todas as requisições são GET para https://api-itsm.argunis.com/api/public/content/v1/… com o cabeçalho Authorization: Bearer ul_ct_…. O espaço vem da chave.

Caminho

O que entrega

space

Nome, descrição e quantidade de páginas do espaço.

tree

O menu: cada página com id, path, title, parentId, posição e data.

pages?path=/primeros-pasos/iniciar-sesion

Uma página pelo caminho.

pages/{id}

Uma página pelo número.

search?q=exportar&label=reportes&limit=20

Busca de texto completo (até 50 resultados).

changes?since=2026-10-01T00:00:00Z

Páginas que mudaram ou deixaram de estar publicadas desde essa data (até 1.000), para manter sua cópia em dia.

assets/{id}

Uma imagem de uma página, com a mesma chave.

curl -H "Authorization: Bearer ul_ct_…" \
  "https://api-itsm.argunis.com/api/public/content/v1/pages?path=/primeros-pasos/iniciar-sesion"

Uma página traz title, description, labels, html, toc (índice de títulos), breadcrumbs, prev, next, updatedAt e version.

  • O html já vem limpo, com os mesmos elementos que a base de conhecimento aceita. Você pode inseri-lo na sua página.

  • Os links entre páginas vêm como /<espacio>/<ruta>. Troque-os pelos caminhos do seu site.

  • As imagens apontam para /api/public/content/v1/assets/<id> e são pedidas com a mesma chave.

  • Se o caminho mudou, a resposta é { "redirect": "/ruta-nueva" }.

O que não entrega

Rascunhos, versões anteriores, comentários, avaliações nem páginas de espaços arquivados.

Relacionado

Pesquisar em Elion ITSM

Digite pelo menos 2 letras para pesquisar em Elion ITSM.

↑↓ navegar · Enter abrir · Esc fechar