BambooHR开发者中心

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

开始

开始使用API

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

容易访问。容易修改。

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

什么都不要错过!

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

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

开始你需要做什么?

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

  • BambooHR的一个账户
  • 用于访问您的帐户的子域(如果您访问BambooHR在https://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响应。

一个月前更新过


接下来是什么

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

技术概述

开始使用API


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

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

您只能建议对Markdown主体内容进行编辑,而不能建议对API规范进行编辑。