应用程序集成

标准API

开始咨询

XChange Advantage的标准API 使客户可与首优咨询筛选平台建立无缝、双向的HTTP/SOAP整合。

支持协议:基于HTTPS的XML数据传输协议(POST)与基于HTTPS(网络服务)的SOAP(简单对象访问协议)数据传输协议。

通过XChange Advantage的标准API ,您可通过您的应用程序整合以下服务:

  • 管理筛选解决方案——用户账户、密码和配置
  • 查看解决方案包——在您的账户中获取一系列解决方案包和筛选选项
  • 筛选订购——开始/更新筛选订单或向候选人发送电子邮件邀请,要求其填写申请
  • 查看状态/筛选结果——按需点开当前报告的状态和URL链接
  • Webhooks——发送实时公告到您的URL地址,如状态通知和筛选结果

只需要在我们的系统中建立一个API账户即可(应要求提供)。在您的开发平台开始使用XChange Advantage 标准API前,我们的文档可为您提供所需的指导信息。

筛选账户/用户管理

账户管理方法

账户列表 ——检索筛选程序所配置的所有账户/子账户

程序包自检 ——检索给定账户所配置的所有筛选程序包

用户配置 —— 可创建新用户、更新用户(访问、选项和组)

用户配置文件关联 可将用户关联到配置文件(访问控制)

单击此处查看API代码示例

筛选订单模式

XChange Advantage标准API提供了三种筛选订购模式:

单步式筛选订单模型

单步式流程可实现全自动的系统对系统对接。收到请求后,首优咨询系统将创建一个筛选订单。

两步式筛选订单模型

两步式流程将XML服务与Enterprise Advantage网站对接。XML请求用于对首优咨询订单进行预填充。

候选人邀请筛选订单模式

邀请候选人在我们的Direct Advantage候选人平台中完成申请。

单击此处查看API代码示例

筛选状态及报告查看方法

获取链接 ——同步订单结果(按需提取),返回案例状态,并链接URL至完整的筛选报告。链接请求只能使用一次。

获取状态 ——同步订单状态(按需提取):返回状态和筛选报告要素,还包括指向“筛选”报告的URL链接。

单击此处查看API代码示例

Webhooks

通知状态 

提供可配置转换内容的Webhook实时状态的异步通知功能,在通知内容(HTML/XML)中可提供完整的详细报告结果,还提供电子邮件状态通知功能

单击此处查看API代码示例

故障

代码说明
100无效XML
200无效的登录名
210用户已锁定
220密码已过期
240账户或用户已禁用
250无效的订单账户
300无效包
320必要数据缺失
500请求错误(这是对意外错误的“总称”)

单击此处查看API代码示例