GLPI REST API - Guia Prático

Exemplos práticos de uso da API REST do GLPI (Gestionnaire Livre de Parc Informatique) para integração e automação de tarefas de gestão de ativos, tickets e outros recursos.  —  Gerador de CURL

Configuração Inicial

Para obter um token de API no GLPI, você precisa seguir os seguintes passos:

1. Habilitar a API REST no GLPI

Primeiro, verifique se a API REST está habilitada:

• Faça login no GLPI como administrador
• Vá para Configuração > Geral > APIs
• Certifique-se de que a opção "Habilitar API REST" esteja ativada

2. Criar um token de API para um usuário

• Vá para Administração > Usuários
• Selecione o usuário para o qual deseja criar o token
• Vá para a seção "Chaves de acesso remoto"
• Marque a opção "re-gerar" e clique em "Salvar"
• Copie a chave gerada

3. Token da aplicação

• Vá para Configuração > Geral > APIs
• Clique no botão "Adicionar clientes da API"
• Insira um nome
• Marque a opção "Ativo" como "Sim"
• Preencha os campos "Início do intervalo de endereços IPv4" e "Fim do intervalo de endereços IPv4"
• Clique no botão "Adicionar"
• Selecione o cliente criado e copie o token.

1) Iniciar Sessão

Headers:

Content-Type: application/json
Authorization: user_token [USER_TOKEN]
App-Token: [APP_TOKEN]

Requisição em formato CURL

2) Trocar Entidade Ativa

Permite alterar a entidade ativa da sessão. Útil quando o usuário tem acesso a múltiplas entidades e precisa operar em uma entidade específica.

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Body (JSON):

{
  "entities_id": 1,
  "is_recursive": true
}

• entities_id: ID da entidade para a qual deseja trocar.
• is_recursive: se true, inclui as sub-entidades.

Requisição em formato CURL

3) Criar um Ticket

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Body (JSON):

{
  "input": {
    "name": "Ticket aberto pela API",
    "content": "Descricao do ticket",
    "priority": "1",
    "impact": "4",
    "urgency": "5",
    "type": "2",
    "itilcategories_id": "1"
  }
}

O campo itilcategories_id corresponde ao ID da categoria ITIL à qual o ticket será associado. As categorias são configuradas no GLPI em Configuração > Dropdowns > Categorias ITIL e organizam os chamados por área ou tipo de serviço. Para descobrir os IDs disponíveis, consulte o item 9) Buscar Categorias.

Requisição em formato CURL

4) Obter Ticket por ID

Retorna os dados completos de um ticket específico.

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Requisição em formato CURL

Para expandir sub-itens (como usuários associados, documentos, etc.), use o parâmetro expand_dropdowns:

5) Atualizar um Ticket

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Body (JSON):

{
  "input": {
    "name": "Novo título do ticket",
    "content": "Nova descrição do ticket",
    "status": 2,
    "priority": 3
  }
}

Requisição em formato CURL

6) Buscar Tickets

Retornar tickets com base em critérios de busca. A principal distinção é o papel do usuário no chamado. Para entender como os filtros são estruturados, consulte Como Montar Filtros de Busca (criteria).

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Tickets abertos por um usuário (requerente)

Filtra tickets nos quais o usuário é o requerente (quem abriu o chamado), usando field=4. No exemplo abaixo, o usuário johndoe e o período entre 9h do dia 13/04/2020 e 9h do dia 14/04/2020:

Requisição em formato CURL

Chamados abertos atribuídos a um usuário (técnico)

Filtra tickets nos quais o usuário é o técnico atribuído, usando field=5. O segundo critério (field=12 com lessthan=5) garante que apenas chamados ainda em aberto sejam retornados, excluindo os com status Solucionado (5) e Fechado (6):

Requisição em formato CURL

7) Listar Campos de um Ticket

Visualizar os campos disponíveis para itemtype Ticket.

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Requisição em formato CURL

8) Listar Campos de Categorias

Visualizar os campos disponíveis para itemtype ITILCategory.

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Requisição em formato CURL

9) Buscar Categorias

Retornar a lista de categorias que estejam listadas na interface simplificada (campo 3). Você pode ajustar o parâmetro range caso deseje evitar a paginação dos resultados.

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Requisição em formato CURL

10) Upload de Documento

Headers:

App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Body (multipart/form-data):

Requisição em formato CURL

Os pontos-chave:

• -F (não -d): indica multipart/form-data, necessário para envio de arquivo binário
• uploadManifest: é o JSON de metadados enviado como parte do form, com ;type=application/json no final para indicar o content-type desse campo
• filename[0]=@: o @ faz o curl ler o conteúdo do arquivo e enviá-lo como binary upload
• Não se coloca header Content-Type: application/json. O curl define automaticamente multipart/form-data quando se usa -F.

11) Download de Documento

Retorna o arquivo binário de um documento armazenado no GLPI.

Headers:

App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]
Accept: application/octet-stream

Requisição em formato CURL

Para obter apenas os metadados (sem baixar o arquivo):

12) Vincular Documento ao Ticket

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Body (JSON):

{
  "input": {
    "documents_id": 1,
    "itemtype": "Ticket",
    "items_id": 3
  }
}

13) Incluir Comentário em um Chamado

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Body (JSON):

{
  "input": {
    "itemtype": "Ticket",
    "items_id": 3,
    "content": "Comentario de teste postado via API."
  }
}

Requisição em formato CURL

14) Atribuir um Ticket a um Usuário

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Body (JSON):

{
  "input": {
    "tickets_id": 3,
    "users_id": 8,
    "type": 2
  }
}

Valores para type:

• 1 - Requerente
• 2 - Técnico (atribuído)
• 3 - Observador

Requisição em formato CURL

15) Listar Sub-itens de um Ticket

Retorna os sub-itens associados a um ticket, como acompanhamentos (followups), tarefas, documentos, usuários, etc.

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Valores comuns para sub_itemtype:

• ITILFollowup - Acompanhamentos/comentários
• TicketTask - Tarefas
• Document_Item - Documentos vinculados
• Ticket_User - Usuários associados
• TicketValidation - Validações

Requisição em formato CURL

Listar acompanhamentos de um ticket:

Listar tarefas de um ticket:

Listar documentos vinculados a um ticket:

16) Fechar um Chamado

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Body (JSON):

{
  "input": {
    "id": 3,
    "status": 6
  }
}

Valores para status:

• 1 - Novo
• 2 - Em atendimento (atribuído)
• 3 - Planejado
• 4 - Pendente
• 5 - Solucionado
• 6 - Fechado

Requisição em formato CURL

17) Excluir um Ticket

Move um ticket para a lixeira ou exclui permanentemente.

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Requisição em formato CURL

Mover para a lixeira (exclusão lógica):

Excluir permanentemente (force purge):

18) Listar Usuários

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Por padrão retorna os primeiros 20 registros. Para paginar, use o parâmetro range na URL.

Requisição em formato CURL

Para paginar resultados:

Para buscar um usuário específico por nome, use searchText:

19) Encerrar Sessão

Encerra a sessão ativa e invalida o Session-Token.

Headers:

Content-Type: application/json
App-Token: [APP_TOKEN]
Session-Token: [SESSION_TOKEN]

Requisição em formato CURL

Referência de Valores

Os valores de status, prioridade, urgência, impacto e tipo de chamado são fixos (hardcoded) no GLPI e não há função de API para retorná-los como uma lista isolada. Eles estão definidos no código-fonte do GLPI:

Status

Urgência, Impacto e Prioridade

Tipo do Chamado

Como Montar Filtros de Busca (criteria)

Os endpoints de busca da API do GLPI (como GET /apirest.php/search/Ticket) aceitam filtros compostos por meio do parâmetro criteria, que é um array indexado. Cada índice representa uma condição independente de filtro.

Estrutura de um critério

Cada critério criteria[N] é composto por quatro sub-parâmetros:

Campos mais utilizados em Ticket

Os IDs de campo são obtidos via 7) Listar Campos de um Ticket. Os mais comuns são:

Exemplo comentado

A query abaixo retorna chamados abertos atribuídos ao técnico johndoe. Cada linha corresponde a um critério:

criteria[0][link]=AND
criteria[0][field]=5           ← campo: técnico atribuído
criteria[0][searchtype]=contains
criteria[0][value]=johndoe     ← nome do usuário

criteria[1][link]=AND
criteria[1][field]=12          ← campo: status
criteria[1][searchtype]=lessthan
criteria[1][value]=5           ← menor que 5 = exclui Solucionado e Fechado

Na URL, os parâmetros são concatenados com & e o array usa a notação de colchetes (criteria[0][field]=5&criteria[1][field]=12). Para adicionar mais condições, basta incrementar o índice ([2], [3]...).