GLPI项目REST API全面指南：从入门到精通

GLPI项目REST API全面指南：从入门到精通

glpi glpi-project/glpi: 是一个用于管理 IT 资产和服务的 PHP 应用程序。适合用于 IT 资产管理和服务管理。特点是提供了简单的 API，支持多种 IT 资产和服务管理功能，并且可以自定义数据模型和行为。 项目地址: https://gitcode.com/gh_mirrors/gl/glpi

前言

GLPI作为一款开源的IT资产管理和服务台系统，提供了强大的REST API接口，允许开发者通过编程方式与系统进行交互。本文将全面介绍GLPI REST API的核心概念、使用方法和最佳实践，帮助开发者快速掌握API的使用技巧。

核心概念解析

1. 基础术语

端点(Endpoint) API提供的资源访问点，通常表现为特定的URL路径。例如/apirest.php/initSession/就是一个端点。

HTTP方法(Method) 定义了对资源执行的操作类型，GLPI API支持以下主要方法：

• GET：获取资源
• POST：创建资源
• PUT/PATCH：更新资源
• DELETE：删除资源

项目类型(itemtype) GLPI系统中的数据类型，可以是资产、ITIL对象或配置项等。每种类型都继承自CommonDBTM类。

2. 认证机制

GLPI API提供了三种认证方式：

1. 基本认证：使用用户名和密码的Base64编码
2. 用户令牌：通过用户设置中的"远程访问密钥"
3. 应用令牌：系统配置中为API客户端分配的标识符

API使用详解

1. 会话管理

初始化会话

curl -X GET \
-H 'Content-Type: application/json' \
-H "Authorization: Basic Z2xwaTpnbHBp" \
'http://your-glpi-instance/apirest.php/initSession'

关键参数：

• get_full_session：设为true可获取完整会话信息
• 认证方式可选择基本认证或用户令牌

终止会话

curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: your_session_token" \
'http://your-glpi-instance/apirest.php/killSession'

2. 密码重置

GLPI提供了完整的密码重置流程API：

1. 请求密码重置（发送通知）

curl -X PUT \
-H 'Content-Type: application/json' \
-d '{"email": "user@example.com"}' \
'http://your-glpi-instance/apirest.php/lostPassword'

2. 使用令牌设置新密码

curl -X PUT \
-H 'Content-Type: application/json' \
-d '{"email": "user@example.com", "password_forget_token": "token_value", "password": "new_password"}' \
'http://your-glpi-instance/apirest.php/lostPassword'

3. 用户配置管理

GLPI API允许查询和修改用户配置：

• 获取用户所有配置档案：/getMyProfiles/
• 获取当前活跃档案：/getActiveProfile/
• 更改活跃档案：/changeActiveProfile/ (需POST方法)

4. 实体管理

对于多实体环境，API提供：

• 获取用户可访问的所有实体：/getMyEntities/
• 获取当前活跃实体：/getActiveEntities/
• 更改活跃实体：/changeActiveEntities/

5. 数据查询

获取特定项目数据的通用端点：

/apirest.php/:itemtype/:id

实用查询参数：

• expand_dropdowns：显示下拉菜单名称而非ID
• with_networkports：包含网络端口信息
• with_softwares：包含软件信息（仅限计算机类型）

最佳实践

1. 会话管理：

   • 会话默认是只读的，如需写入操作需设置session_write=true
   • 合理管理会话生命周期，及时销毁不再需要的会话

2. 性能优化：

   • 使用get_sha1参数获取数据签名，减少传输量
   • 按需请求关联数据，避免不必要的数据加载

3. 错误处理：

   • 正确处理API返回的状态码：
     • 200：成功
     • 400：请求参数错误
     • 401：认证失败
     • 404：资源不存在

4. 安全建议：

   • 在生产环境启用IP过滤和应用令牌
   • 避免在客户端存储用户凭证，优先使用用户令牌

高级功能

1. 批量操作：

   • 通过/apirest.php/:itemtype/端点实现批量创建和查询

2. 文件上传：

   • 使用multipart/form-data内容类型上传文件

3. 复杂查询：

   • 利用搜索选项(searchOption)构建高级查询条件

结语

GLPI的REST API提供了系统功能的完整访问接口，通过合理使用这些API，开发者可以构建强大的集成解决方案和自动化工作流。本文涵盖了API的核心概念和主要使用方法，建议在实际开发中结合官方文档和具体业务需求进行深入探索。

记住，良好的API使用习惯包括合理的错误处理、资源清理和性能优化，这些都将显著提升集成的稳定性和用户体验。

glpi glpi-project/glpi: 是一个用于管理 IT 资产和服务的 PHP 应用程序。适合用于 IT 资产管理和服务管理。特点是提供了简单的 API，支持多种 IT 资产和服务管理功能，并且可以自定义数据模型和行为。 项目地址: https://gitcode.com/gh_mirrors/gl/glpi