1.北森开放平台简介
通过北森开放平台,客户可以调用北森的开放接口,将客户现有的系统与北森人才管理平台进行深度嵌入集成。比如通过北森开放平台,中广核的招聘系统或HR系统就可以与北森的测评业务进行集成,将北森的人才管理测评的整个流程,融入到他们的业务流程中。
1.1.验证与授权
开放平台验证与授权基于标准OAuth2.0。
使用北森开放平台提供的API接口之前,需要在北森注册一个应用(请联系北森项目经理进行开通,并发送给客户开通接口后的授权回执单(包含token))。
基于OAuth2.0获得一个专属的Token值,使用方式跟其他一些协议中的方案类似,主要给每个请求添加签名验证。配置好Token值(Bearer +Token值)即可进行API的调用。
重要提醒:Bearer和Toke之间有空格,形式为Bearer 1234567890
Token的使用即在接口调用的http header中添加参数("Authorization", token);
1.2.接口协议及规范
相关接口同时支持http和https两种传输协议,URL接口遵循RESTful(JSR311)相关设计规范。
1.3.数据返回格式
JSON
1.4.开放平台错误代码返回
错误标识 | 错误代码 | 备注 |
---|---|---|
CLIENT_GENERAL_ERROR_MESSAGE | 400 | 客户端请求错误 |
UNAUTHORIZED_MESSGAE | 401 | 未授权 |
CONSUMER_EMPTY_MESSGAE | 402 | Consumer key不能为空 |
TENANT_ID_INVALID_MESSGAE | 403 | 租户ID无效 |
AUTHENTICATION_ERROR_MESSGAE | 404 | 认证错误 |
AUTHORIZATION_ERROR_MESSGAE | 405 | 授权错误 |
NOT_FOUND_MESSGAE | 406 | 资源未找到 |
INVALID_REQUEST_MESSAGE | 407 | 无效请求,请检查请求参数 |
NOT_MATCH_MESSGAE | 408 | Consumer key与租户ID不匹配 |
CONSUMER_NOT_EXIST_MESSGAE | 409 | Consumer key不存在 |
TOKEN_EMPTY_MESSAGE | 410 | Token不能为空 |
TOKEN_INVALID_MESSAGE | 411 | 无效Token |
TOKEN_EXPIRED_MESSAGE | 412 | Token过期 |
APPLICATION_DISABLED_MESSAGE | 414 | 应用程序已经被禁止 |
APPLICATION_EXPIRED_MESSAGE | 415 | 应用程序过期 |
SERVER_GENERAL_ERROR_MESSAGE | 500 | 服务器端错误 |