OpenApply的公共 API 和扩展功能

OpenApply为学校提供公共 API，以便安全地访问其数据和文件。无论您是拥有专门的编程团队（或者更可能是才华横溢的单人程序员！），还是使用第三方来帮助您构建基础设施，您都可以通过公共 API 与OpenApply集成。

Faria Education Group提供对公共 API 的支持，您可以通过OpenApply帐户的“设置”直接访问以下路径：设置 > 开发 > 公共 API 或 API 文档

除了提供全套公共 API 外，我们还提供支持文章，演示如何使用它们来完成常用任务。

以下是一些说明示例。

探索Faria Education Group API：集成门户

Faria Faria Education Group为OpenApply 、 ManageBac和SchoolsBuddy提供强大的 API，支持各种集成和自动化需求。Faria 现在建议从集成门户开始，以获得流畅的基于浏览器的体验，包括使用您自己的凭据进行实时端点测试。

集成门户：推荐方法

集成门户旨在让用户直接在浏览器中进行交互式 API 探索和实时测试。

主要优势：

• 无需安装任何软件：所有功能都在浏览器中运行。
• 在线“测试”按钮：立即试用 API 端点并查看真实响应。
• 安全的凭证管理：使用您自己的 API 密钥或 OAuth 凭证进行身份验证。
• 即时反馈：实时排查并了解 API 行为。

如何开始：

1. 访问集成门户。
2. 选择您的产品（ OpenApply 、 ManageBac 、 SchoolsBuddy ）。
3. 浏览 API 文档并选择一个端点。
4. 点击“测试”按钮。
5. 请输入您的身份验证凭据（设置方法请参见下文）。
6. 填写所需参数并提交请求。
7. 直接在门户网站查看实时响应。

身份验证设置：

• OpenApply v3：
  • 前往OpenApply > 集成 > 公共 API。
  • 启用公共 API 并添加一个新的 OAuth 应用程序来生成您的客户端 ID 和密钥。
  • OpenApply v3 API 身份验证指南
• ManageBac+ v2：
  • 前往ManageBac > 设置 > 集成 > API 访问。
  • 生成或获取您的 API 密钥。
  • ManageBac+ v2 API 身份验证指南
• SchoolsBuddy ：
  • 前往SchoolsBuddy > 设置 > API 管理器 > 点击“添加”
  • 生成您的客户端 ID 和密钥

  • SchoolsBuddy API 身份验证指南

如何通过 API 从OpenApply检索学生关联的文件

问题： OpenApply是招生流程的入口，家长需要在此上传护照照片和其他信息。您希望能够将这些信息存储在其他系统中，或者上传到学校的学生信息系统 (SIS) 或管理信息系统 (MIS) 平台。

解决方案： OpenApply具有导出功能，可以批量导出所有文件，但如果您想要自动化流程，可以使用 API 来实现此目的。

笔记：

• OpenApply中已启用 API 访问权限（需要管理员权限）
• OpenApply中生成的 OAuth 2.0 客户端 ID 和密钥：
• 熟悉 API 请求和身份验证

API 身份验证指南

涉及步骤：

1. 我们支持使用 API 获取所有学生信息，包括筛选功能以及自上次调用以来的更新。这些学生信息包含指向申请表中所提交 PDF 文件的秘密链接。
2. 然后，您可以安全地下载这些资源，保存到磁盘，或上传到目标平台。

通过 API 获取学生文件
导出特定学生的资料：

 GET /api/v3/students/{id}/files

• 将{id}替换为学生的OpenApply数据库 ID。
• 使用since_date参数可以仅获取自上次导出以来更新的文件。

例子：

 curl -X GET "https://api.openapply.com/api/v3/students/12345/files?since_date=2026-01-01" \
-H "授权：持有者 YOUR_ACCESS_TOKEN"

响应中包含每个文件的元数据和安全 URL，您可以根据需要下载和处理。

API 参考 – 文件

自动和定时导出

• 使用since_date参数可以只获取新增或更新的文件。
• 安排集成程序定期运行（例如，每晚运行），以保持目标系统保持最新状态。
• 安全存储 API 凭证，并根据需要进行轮换。

安全最佳实践

如何下载自定义字段以及如何按自定义字段搜索

问题：学校可以使用OpenApply创建无限数量的自定义字段，并填充有价值的数据。虽然OpenApply也支持强大的导出功能，但为了实现流程自动化，我们该如何使用 API 来帮助我们管理数据工作流程呢？

解决方案：本文展示了如何使用OpenApply API 和v3 身份验证在自定义字段中查找信息。学生端点包含该学生的所有自定义字段及其值（如果存在）。此外，您还可以使用搜索端点来检索自定义值与特定字符串匹配的学生。