概述
本指南概述了如何使用Postman对ADP进行第一次应用程序编程接口(API)调用。188bet金宝搏app
本指南有什么新内容?
2020年7月
更新如下:
- 文件中的URL (Uniform Resource Locator)安装和准备邮差部分
- 各个部分下的各种步骤
- 188bet金宝搏appADP端点信息
- 所有部分下的屏幕截图
先决条件
在进行第一个API调用之前,您需要准备以下内容:
- 客户机ID而且客户的秘密-如果您没有这些信息,请联系您的客户代表。
- 证书签名请求(CSR)——有关更详细的信息,请参见生成证书签名请求.
安装和准备邮差
- 安装邮差https://www.postman.com/downloads/.
- 使用以下步骤,添加您的ADP颁发的证书文件和您的188bet金宝搏app。key文件(作为CSR流程的一部分创建)到您正在使用的每个环境的Postman中。你可以使用在https://learning.postman.com/docs/sending-requests/certificates/.
- 点击设置菜单上的。
- 完成以下指令两次。一次accounts.188bet金宝搏appadp.com随着宿主有一次api.188bet金宝搏appadp.com随着宿主.
如果您正在连接到UAT实例,则主机为uat-accounts.188bet金宝搏appadp.com而且uat-api.188bet金宝搏appadp.com,分别。 - 点击证书然后进入主机、CRT文件(证书)关键文件。然后,单击添加.
在设置翻到下一页SSL证书验证上。
如果没有提示您选择安全套接字层(SSL)证书,并且这是您在此Postman会话中的第一个请求,那么您应该确保正确安装了SSL证书。在您选择了适当的证书之后,直到您开始一个新的Postman会话之前,不会再次提示您输入证书。如果您知道您的SSL证书已正确安装,请关闭Postman,打开谷歌Chrome浏览器,并再次尝试您的请求。
- 点击设置菜单上的。
如果需要,导入ADP api。188bet金宝搏app
Postman允许您存储api集合并与其他人共享。188bet金宝搏appADP将继续在GitHub上共享样本集合。
例如,您可以通过单击找到ADP Workforce Now集188bet金宝搏app合在这里.到达指定位置后,下载文件并单击进口导入列表文件。
打第一个电话
请求不记名令牌
对ADP api的每个请求都需要附带一个授权标188bet金宝搏app头,该标头包含由ADP安全令牌服务颁发的承载令牌。188bet金宝搏app
- 创建一个新的POST调用https://accounts.188bet金宝搏appadp.com/auth/oauth/v2/token.如果你下载了GitHub上可用的ADP集合之一,你可能有预先构建的调188bet金宝搏app用来为你做大部分工作。
- 打开头选项卡以公开标头并添加内容类型标头的价值的应用程序/ x-www-form-urlencoded.
- 开放身体,并按以下屏幕截图所示输入键(使用您自己的API客户端ID而且秘密).
如果连接到UAT环境,则此调用的URL为https://uat-accounts.188bet金宝搏appadp.com/auth/oauth/v2/token.
如果POST请求成功,您将收到来自服务器的HTTP 200,响应正文中包含您的令牌。复制access_token价值。 - 您将在响应中收到一个访问令牌,有效期为1小时。同样可以通过添加以下头文件来进行API调用:
授权:持有者{accessToken}
使用不记名令牌进行API调用
如果已经有一个API集合,可以从集合中选择一个API。下面的示例显示了选择GET HR - Worker (List) API并进行第一次调用。
- 打开HR >员工(名单)请求并单击头以公开头文件。
将您的记名令牌粘贴到授权标头中,然后单击发送.
记住,在你的代币左边留出一个空间。由于Postman是一个基于浏览器的应用程序,所以浏览器缓存机制将响应保存到缓存中。为了确保您在ADP应用程序中所做的更改反映在Postman中,我们建议188bet金宝搏app在每个请求之间的查询字符串中放置一个cache-buster。
例如,preventCache =时间戳,在那里时间戳是一个惟一值,例如当前时间。在构建应用程序时不需要这样做,因为基于浏览器的缓存不会发挥作用。
如果请求成功,您将在几条记录内收到来自服务器的HTTP 200消息。下面的示例显示了GET HR - Worker (List) API请求的响应:
经常遇到的错误和解决方案
尝试使用ADP的安全令牌服务进行身份验证时收到HTTP 401错误188bet金宝搏app188bet金宝搏app
错误
当您未能在请求头中提供有效凭据时,ADP安全令牌服务将返回HTTP 401错误188bet金宝搏app。188bet金宝搏app
决议
在联系ADP代表寻求帮助之前,请采取以下故障排除步骤:188bet金宝搏app
- 确保您的开放授权2 (OAuth2)中有base-64编码客户机ID而且客户的秘密在将它们发送到授权头之前。
- 确保你也是用base-64编码冒号(:)之间的OAuth2客户机ID而且客户的秘密.
- 确保在Basic和base-64编码凭证之间有空格。
- 确保在请求中包含adp颁发的安全套接字层(SSL)证书。188bet金宝搏app
从其他api收到一个HTTP 401错误
错误
当您未能在请求头中提供有效的承载令牌时,将从ADP安全令牌服务以外的api返回HTTP 401错误。188bet金宝搏app188bet金宝搏app
决议
在联系ADP代表寻求帮助之前,请采取以下故障排除步骤:188bet金宝搏app
- 确保已向请求添加了授权标头,以及从ADP安全令牌服务获取的承载令牌。188bet金宝搏app188bet金宝搏app
- 确保在承载者和授权标头中使用的令牌之间有一个空格。
- 类型的响应正文过期的令牌消息。如果该消息出现在响应中,则获取一个新的不记名令牌并重新提交请求应能解决该问题。
收到一个HTTP 403错误
错误
当您提供的承载令牌有效,但您没有被授权访问所请求的资源时,将从服务器返回HTTP 403错误。
决议
首先,确认您在请求统一资源指示器(Uniform Resource Indicator, URI)中没有犯错误。如果请求URI正确,请与您的ADP代表联系,请求访问相关URI。188bet金宝搏app
其他有用连结
- API常见异常和处理提示
- 邮差样本收集:https://github.com/188bet金宝搏appadpllc/marketplace-sample-payloads/blob/master/wfn/ADP%20WFN%20APIs.postman_collection.json
使用邮差收藏
- 导航到https://github.com/188bet金宝搏appadpllc/marketplace-sample-payloads/tree/master/wfn.
- 复制整个JavaScript对象表示法(JSON),如下所示:
- 选择邮递员>导入标签>粘贴原始文本.
- 点击进口.