ADP API 集成指南:使用 OAuth 连接管理器和 JSON 源获取数据

作者:API传播员 · 2025-10-09 · 阅读时间:3分钟
本文详细介绍了如何通过OAuth连接管理器结合HTTP连接管理器与JSON源,成功集成ADP API。内容包括准备客户端ID和客户端密钥、使用PFX格式的客户端证书进行身份验证、以及如何将.cer和.key文件转换为.PFX文件的步骤。此外,还介绍了使用ZappySys JSON Source或REST API工具通过OAuth连接建立与ADP API的HTTP连接的方法。

一. ADP API 集成概述

本文将详细介绍如何通过 OAuth 连接管理器,结合 HTTP 连接管理器JSON 源,成功集成 ADP API。ADP API 在使用 OAuth 连接管理器时存在一些特殊要求,本文将逐步解答这些问题,帮助您顺利完成集成。


二. 集成前的准备工作

在开始操作之前,请确保已准备以下内容:

1. 客户端 ID 与客户端密钥

  • Client IDClient Secret 是调用 ADP API 的必备凭证。
  • 这些信息由 ADP 提供,用于验证您的身份。

2. 客户端证书(PFX 文件)

  • ADP API 要求使用 PFX 格式的客户端证书进行身份验证。
  • 注意事项:

    • 当 PFX 文件过期时,ADP API 可能会抛出通用 SSL/TLS 通道错误,容易误判为其他问题。
    • 建议定期检查证书有效期,确保 API 调用顺利。
  • 验证步骤:

    1. 将 PFX 文件导入本地证书存储。
    2. 使用相同的空密码进行配置。

三. 将 .cer 和 .key 文件转换为 PFX 文件

如果您手头有独立的 .cer.key 文件,需要将它们合并为一个 .PFX 文件(PKCS#12 格式)以兼容 ADP API。

转换步骤:

  1. 使用 OpenSSL 工具合并证书和私钥:
openssl pkcs12 -export -out certificate.pfx -inkey private.key -in certificate.cer
  1. 设置合适的导出密码,并妥善保存生成的 certificate.pfx 文件。

完成上述步骤后,即可获得符合 ADP API 要求的 PFX 证书文件。


四. 成功建立 HTTP 连接

在准备好凭证和 PFX 证书后,您可以通过 ZappySys JSON SourceREST API 工具 与 ADP API 建立 HTTP 连接:

  • 支持 OAuth 连接管理器配置
  • 支持灵活的数据源集成
  • 提供分页、筛选和错误处理等高级选项

通过配置正确的 OAuth 参数和 PFX 证书,即可顺利实现数据交互。


五. 总结与注意事项

通过本文指导,您可以:

  • 了解 ADP API 对 OAuth 和证书的特殊要求
  • 成功生成符合要求的 PFX 文件
  • 使用 ZappySys 工具快速建立 API 连接

操作建议:

  1. 确保 OAuth 参数配置正确,包括 Client ID、Client Secret、回调 URL 等。
  2. 定期检查 PFX 证书的有效期,防止因证书过期导致连接失败。
  3. 在调试 API 调用时,可使用 Fiddler 或类似工具监控请求与响应,确保配置正确。

原文链接: https://zappysys.com/blog/connect-adp-api-using-http-connection-oauth-connection/