竹子

竹子开发人员中心

欢迎来到竹子开发人员中心。你'LL找到全面的指南和文档,以帮助您尽快使用竹子,以及如果您陷入困境,支持。让's jump right in!

开始

API入门

我们的Open API可以轻松将其他应用程序集成到Bamboohr中。使用本指南即可在系统中开始在系统中共享数据。

易于访问。易于修改。

Bamboohr API是一个恢复的互联网协议,其围绕制作语义有意义的HTTPS请求来访问或修改资源(通常由员工完成)。 API可用于操纵员工数据并以多种格式生成报告。

永远不要错过任何东西!

注册我们的邮件列表以在有计划更改或添加到API添加时接收更新。我们可能偶尔会伸出您的意见're up to!

在此注册: //www.csjutong.com/api-mailing-list/

你需要什么开始呢?

如果您是客户或正在构建单个竹子客户的集成:

  • 竹子的账户
  • The subdomain used to access your account (If you access BambooHR at //mycompany.csjutong.com, then the subdomain is "mycompany")
  • API键(见 验证 下面有关获得API键的说明)

如果您正在为多个客户构建集成:

  • 申请 这里 获得客户ID和秘密
  • 询问相互客户的竹子子域
  • 使用 Openid Connect. 获取竹子用户的API密钥

验证

从第三方应用程序发送到Bamboohr网站的每个API请求都将被认证和许可,好像是真实用户使用该软件。与API请求相关联的用户的权限将确定允许每个API请求查看和/或编辑哪些字段和员工。

要生成API密钥,用户应登录并单击任何页面的右上角的名称以获取用户上下文菜单。如果他们有足够的权限,就会有一个"API Keys"该菜单中的选项转到页面。

每个用户可以具有一个或多个秘密API键,其将该用户识别到API。 API秘密密钥是以十六进制形式表示的160位数字。这是一个天文学上大量的唯一键,这意味着猜测API键几乎不可能。

在HTTP级别,API密钥通过HTTP基本身份验证发送。使用秘密密钥作为用户名和密码的任何随机字符串。

要使用CURL来制作API请求尝试:

curl -i -u "{API Key}:x" "//api.csjutong.com/api/gateway.php/{subdomain}/v1/employees/directory"

大多数浏览器和工具都可以接受URL,如:

//{API Key}:[email protected]/api/gateway.php/{subdomain}/v1/employees/directory

有关HTTP基本身份验证的更多信息,请参阅 这个有用的维基百科文章 .

如果重复使用未知的API键,则API将禁用一段时间的访问。用户仍然能够在此期间登录Bamboohr网站。禁用API时,它将返回HTTP 403对其接收的任何请求禁止响应。

大约一个月前更新


下一步是什么

查看有关为API标准响应代码进行请求的详细信息。

技术概述

API入门


我们的Open API可以轻松将其他应用程序集成到Bamboohr中。使用本指南即可在系统中开始在系统中共享数据。

建议的编辑是有限的API参考页面

您只能建议编辑到跨越身体内容,而不是API规范。