BambooHR

BambooHR开发人员中心

欢迎使用BambooHR开发人员中心。您'您将找到全面的指南和文档,以帮助您尽快开始使用BambooHR,并在遇到困难时提供支持。让's jump right in!

开始使用

API入门

我们的开放API使将其他应用程序轻松集成到BambooHR中变得容易。使用本指南开始跨系统共享数据。

易于访问。易于修改。

BambooHR API是一种RESTful Internet协议,基于发出语义上有意义的HTTPS请求以访问或修改资源(通常由员工完成)而构建。该API可用于处理员工数据并生成多种格式的报告。

永远不会错过任何事情!

注册我们的邮件列表,以在API计划进行更改或添加时接收更新。我们可能偶尔会与您取得联系,'re up to!

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

您将需要什么入门?

如果您是客户或正在为单个BambooHR客户建立集成:

  • BambooHR的帐户
  • The subdomain used to access your account (If you access BambooHR at //mycompany.csjutong.com, then the subdomain is "mycompany")
  • API密钥(请参阅 认证方式 以下有关获取API密钥的说明)

如果要为多个客户建立集成:

  • 应用 这里 获取客户ID和机密
  • 向共同客户请求BambooHR子域
  • 采用 OpenId连接 为BambooHR用户获取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禁止响应。

12天前更新


下一步是什么

查看有关向API标准响应代码发出请求的更多详细信息。

技术概述

API入门


我们的开放API使将其他应用程序轻松集成到BambooHR中变得容易。使用本指南开始跨系统共享数据。

建议的编辑仅限于API参考页

您只能建议对Markdown正文内容进行修改,而不能建议对API规范进行修改。