BambooHR开发人员中心

欢迎来到BambooHR开发者中心。您将找到全面的指南和文档,帮助您尽可能快地开始使用BambooHR,以及如果您遇到困难时的支持。让我们开始吧!

开始

开始使用API

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

易于访问。易于修改。

BambooHR API是一个基于rest的互联网协议,它构建在访问或修改资源(通常由员工完成)的有语义意义的HTTPS请求之上。该API可用于操作员工数据,并以多种格式生成报告。

什么都不要错过!

注册我们的邮件列表,以便在API有计划更改或添加时接收更新。我们可能偶尔会就我们正在做的事情征求你的意见!

注册://www.vietgest.com/api-mailing-list/

你需要什么开始?

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

  • BambooHR的账户
  • 用于访问您的帐户的子域(如果您访问BambooHRhttps://mycompany.bamboohr.com,则子域名是“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" "https://api.bamboohr.com/api/gateway.php/{subdomain}/v1/employees/directory"

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

https://{API密钥}:(电子邮件保护)/ api / gateway.php /{子域名}/ v1 /员工/目录中

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

如果重复使用未知的API密钥,API将在一段时间内禁止访问。在此期间,用户仍然可以登录到BambooHR网站。当API被禁用时,它将向接收到的任何请求发送一个HTTP 403 Forbidden响应。

更新4天前


接下来是什么

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

技术概述

开始使用API


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

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

您只能建议对标记正文内容进行编辑,但不能对API规范进行编辑。