开始使用API

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

易于访问。易于修改。

Bamboohr API是一种固定的Internet协议,旨在使语义上有意义的HTTPS请求访问或修改资源(通常由员工完成)。API可用于操纵员工数据并以多种格式生成报告。

永远不要错过任何东西!

注册我们的邮件列表,以在有计划的更改或API添加时接收更新。我们偶尔可能会伸出援手,以获取您对我们所做的事情的投入!

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

您需要开始什么?

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

  • 带有Bamboohr的帐户
  • 用于访问您帐户的子域(如果您在https://mycompany.bamboohr.com,然后子域是“ mycompany”)
  • API键(请参阅验证以下有关获取API键的说明)

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

  • 申请这里获取客户ID和秘密
  • 向共同客户询问Bamboohr子域
  • 利用OpenID Connect为Bamboohr用户获取API键

验证

从第三方应用程序发送到Bamboohr网站的每个API请求将经过身份验证并许可,就像真实用户正在使用该软件一样。与API请求关联的用户的权限将确定允许每个API请求的字段和员工可以查看和/或编辑。

要生成API键,用户应登录并单击任何页面右上角的名称,以获取“用户上下文”菜单。如果它们具有足够的权限,则该菜单中将有一个“ API键”选项,可以转到页面。

每个用户可能具有一个或多个秘密API键,可以将该用户识别为API。API秘密键是以十六进制形式表达的160位编号。这是一个天文数量的独特键,这意味着猜测API键几乎是不可能的。

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

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

curl -i -u“ {api key}:x”“ https://api.bamboohr.com/api/gateway.php/ {subdomain }/v1/employees/directory”

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

https:// {api key}:[电子邮件保护]/PI/gateway.php/ {subdomain }/v1/employees/directory

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

如果反复使用未知的API键,则API将在一段时间内禁用访问。在此期间,用户仍然可以登录到Bamboohr网站。禁用API时,它将向其收到的任何请求发送HTTP 403禁止响应。


下一步是什么

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