1. 简介
Bullhorn是一款适用于招聘行业的 CRM(客户关系管理)软件,bullhorn-client是针对Bullhorn API的Node.js客户端库。它提供了一个简单易用的接口,用于与Bullhorn REST API进行交互。
在本篇文章中,我们将向您介绍 bullhorn-client的使用方法。 我们将覆盖安装、设置身份验证、编写 API 请求和处理 API 响应的基础知识。
2. 安装
您可以在 Node.js 项目中使用 npm 安装 bullhorn-client 这个包。在终端/命令行提示符中运行以下命令:
npm install bullhorn-client
安装完成后,你可以通过 require() 函数使用 bullhorn-client 。
const bh = require('bullhorn-client');
3. 身份验证
在使用 bullhorn-client 操作 Bullhorn API 之前,您需要设置身份验证令牌。 身份验证令牌是通过 Bullhorn 管理中心生成的一对访问令牌(access_token,refresh_token),其中 access_token 的有效期为一小时,过期后需要使用 refresh_token来获取新的 access_token。
-- -------------------- ---- ------- ----- -- - --------------------------- ----- ------ - - ------------- ------------------------------------------------ -------- -------------------------------------------------- --------- ----------------- ------------- --------------------- --------- ---------------- --------- ---------------- ----------------- ----- -- ----------------- --------------------- --------- -- - -- ----- - ------------------- - ---- - -------------------------- --------------------------- - ---
您可以在配置对象中传入以下参数:
restTokenUrl
:获取 access_token 的 REST API URL。必须为 Bullhorn API 客户端上的默认值:https://auth.bullhornstaffing.com/oauth/token。restUrl
:要使用的 Bullhorn REST API URL(例如:https://rest.bullhornstaffing.com/rest-services)。必须为 Bullhorn API 客户端上的默认值。clientId
:用于访问 Bullhorn API 的 client ID。clientSecret
:用于访问 Bullhorn API 的 client secret。username
:您的用户用户名,在 Bullhorn 加入时由管理员指定。password
:您的用户密码。useTestEndpoints
:如果是测试模式,则设置为 true。默认值为 false。
4. API请求
您可以使用 bullhorn-client 对 Bullhorn API 进行 CRUD操作 (Create, Read, Update, Delete)。
下面是使用 bullhorn-client 对 Candidate (候选人)实体的一个示例子。
-- -------------------- ---- ------- ----- -- - --------------------------- ----- ----- - -------------------- ----- ------ - ------ ------------ ----------- --------- ------------------------- -------- -------- ----- --------- -- - -- ----- - ------------------- - ---- - --------------------------- - ---
当您向 API 发出请求时,可以有多个选项可供选择,以定制请求的行为。
bh.<entity_name>.<method_name>(params, options, callback);
以下是一些可用的选项:
fields
:一个数组,表示要返回的字段。如果不指定,则返回整个实体。where
:一个数组,表示要使用的where子句。如果不指定,则返回所有记录。count
:一个数字,表示要返回的行数(最大值为 500),默认为 100。start
:一个数字,表示要从哪行开始返回数据。默认为第一行。
其他可用的选项,请参阅官方文档。
5. API响应
Bullhorn API 响应包含一些有用的信息,例如 HTTP 状态代码、响应标头和响应正文(通常是JSON格式的)。
以下是读取 API 响应的一种方法,以处理 JSON 数据:
bh.<entity_name>.<method_name>(params, options, (err, response) => { if (err) { console.error(err); } else { console.log(JSON.parse(response.data)); } });
在这个例子中,我们使用 JSON.parse() 将响应数据解析为 JavaScript 对象。 您可以根据需要使用 JSON.stringify() 将对象转换回 JSON 字符串。
6. 总结
在本篇文章中,我们介绍了使用 bullhorn-client 包与Bullhorn API 进行交互的基础知识。我们涉及了如何设置身份验证令牌,如何进行 API 请求,如何处理 API 响应等方面。
有兴趣使用Bullhorn API打造一款招聘类应用的前端开发者,可以通过此篇文章了解到 BULLHORN-CLIENT的基本操作以及实际的应用,希望本篇文章对他们有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066c8eccdc64669dde56d9