纳税

介绍

Candidate Ingestion API使温室共享共同客户的采购伙伴能够提交潜在客户和候选人。188bet安卓APP

该API允许合作伙伴:

  1. 将合作伙伴应用程序发送到温室的候选人。188bet安卓APP
  2. 检索候选人的当前阶段和状态。
  3. 检索允许Greenhouse用户操作的作业。188bet安卓APP

注意:组织必须能够创建前景,以便使用候选人摄取API创建前景。

验证

这个API提供了两种身份验证方法:OAuth 2.0和Basic Auth。

通过OAuth 2.0进行身份验证

如果共同客户的用户在Greenhouse和合作伙伴的系统中都有帐户,首选的身份验证方法是188bet安卓APPOAuth 2.0。在这种情况下,合作伙伴将在其网站上放置一个集成选项,允许用户通过合作伙伴的应用程序验证到Greenhouse。188bet安卓APP这类似于允许人们使用Facebook证书注册一个网站。如果合作伙伴要对此进行配置,他们必须向Greenhouse提供以下信息:188bet安卓APP

  1. 应用程序名称:应用程序的名称,因为它会在温室中出现。188bet安卓APP
  2. 应用程序URL.:主应用程序的URL。
  3. 回调URL:这是Greenhouse将向其发送已认证用户的URL188bet安卓APP。
  4. 标志形象:这是一个128x128的图像,将包含在权限模态中。

当温室收到188bet安卓APP此信息时,我们将与消费密钥,消费者秘密,令牌URL和授权URL提供合作伙伴。例如:

属性 示例值
消费者钥匙 bmipe4kwf987654321grlg1nfk1234567ushvlod.
消费者秘密 lqdulabcdefghijklezok2fe5xgzebda123gnxtn.
标记的URL https://api.188bet安卓APPgreenhouse.io/oauth/token.
授权URL https://api.188bet安卓APPgreenhouse.io/oauth/authorize

合作伙伴应使用此信息在其应用程序中启动OAuth 2.0流。注意客户用户可以随时重新击中此功能。有关如何配置(包括示例Ruby Gem)的更多信息,可以找到在GitHub上。

当用户尝试连接温室时,他们会看到提示,要求他们确认连接。188bet安卓APP然后,此提示将使用温室帐户将用户的帐户与其温室帐户相关联。188bet安卓APP

提示映像

一旦OAuth进程完成并且用户授予合作伙伴权限以在温室访问其数据,伙伴将接收访问令牌。188bet安卓APP必须包含在授权标题中的访问令牌:

授权:无记名< access_token >

通过Basic Auth进行身份验证

如果您的用户在Greenhouse中只有一个帐户,并且您将作为合作伙伴提交候188bet安卓APP选人(而不是由用户提供来源),那么您可能希望通过HTTP Basic Authentication进行身份验证。用户无需采取任何行动授权您的应用程序修改Greenhouse数据。188bet安卓APP当使用基本身份验证时,您需要为每个请求设置On-Behalf-Of头。该值应该是您所代表的用户的电子邮件地址。例如:

on-behalf-of:john.smith@example.com

通常,这将是专门为此目的创建的服务用户。如果这个头丢失了,或者Greenhouse不能识别地址,AP188bet安卓APPI将发出一个401未经授权响应。应用程序还必须提供API密钥。通过基本身份验证,您将包含API密钥作为基本身份验证用户名,而不包含任何密码。因为在我们的例子中只需要提供一个用户名,所以您需要将一个:(冒号)附加到API令牌,然后Base64对结果字符串进行编码。这可以通过URL包括:

https:// < base64_encoded_api_key >: @188bet安卓APPapi.greenhouse.io / v1 /合作伙伴/候选人

或作为授权标题:

授权:Basic Base64_Encoded_api_key:

在所有情况下,客户将向合作伙伴提供一个合作伙伴API密钥和一个服务用户。这两个项目都需要提交候选人。

注意:Ingestion API的功能将仅限于On-Behalf-Of用户的权限

有四种用户类型,网站管理工作管理员面试官,基本的

Site Admins默认访问所有工作,而作家管理员/面试官被分配给特定的工作。职位管理员/面试官只能通过分配给予访问权限或者在公司的工作委员会上的API来检索作业。然而,他们可以为他们可以访问的工作以及更失业的前景加入候选人。188bet安卓APP

由于所有用户权限都是基于职位的,以便检索API,网站管理员,求职管理员和面试官的失业前景,需要额外的温室许可来管理失业前景。188bet安卓APP否则,他们只能添加前景,而不是检索它们。这也是UI的真实。

基本用户拥有最严格的限制,因为他们在UI中的能力也非常有限:

基本用户可以:*检索工作获取关于当前用户*的信息创建前景在没有工作的情况下,在工作中创造候选人

他们不能:*抢修前景返回候选人*创建一个跟踪链接

OAuth范围

如果使用OAuth进行身份验证,则有3个权限范围要注意。某些端点需要特定的权限范围,而其他端点则需要无需。

一般考虑因素

除非另有说明,API方法一般符合以下规定:

摄入API更改日志

下面的时间戳是东部时间。

日期 描述
2021年4月15日下午03:00:00 添加full_nameid到[GET current_user]响应
2019年8月22日11:00:00 将更改日志和常规考虑部分添加到Engestion API文档中

候选人

检索候选人

旋度'https://api.188bet安卓APPgreenhouse.io/v1/partner/candidates'- h“授权:基本MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6”
{“candidate_ids”17681532}

API的反应

{“id”17681532“名称”“哈利波特”“external_id”“24680”“应用程序”[{“id”59724“工作”“傲罗”“状态”“活跃”“舞台”“应用程序审查”“个人资料网址”“https://app.188bet安卓APPgreenhouse.io/people/17681532?application_id = 26234709 "}]}

检索候选人的数据。请注意,此调用仅返回当前用户有权查看的候选者。

获取https://api.gr188bet安卓APPeenhouse.io/v1/partner/candidates.

范围:candidates.view

请求参数

请求应该包含单个查询参数,该参数指定以逗号分隔的候选ID列表或单个候选ID。如果你提供任何不存在或无法访问的候选ID,该端点将忽略它们,只返回存在于此API密钥或承载令牌的候选ID,或者如果你只提供了一个候选ID,则返回一个空响应。

对于以下用例,带有单个候选ID的“Retrieve candidate”请求将返回一个空数组:

  1. 与用于验证请求的电子邮件地址相关联的Greenhouse用户188bet安卓APP帐户上所做的权限更改(例如,用户已被禁用或剥夺)。
  2. 候选人正在做的工作,用户帐户/电子邮件地址不能访问。请注意,用户帐户必须至少是与候选ID关联的作业的作业管理员。如果添加为前景,用户必须具有管理未附加前景的权限。
  3. 候选档案由组织手动删除。
  4. 候选概要文件上的源被手动更改为与原始合作伙伴源不同的新源。
  5. 候选文件已经与生成新候选ID的另一个概要文件合并。

如果您想了解关于无法访问特定候选人ID的更多信息,请联系客户获取更多细节,因为没有拥有候选人记录的机构的允许,Greenhouse Support不会共享候选人详细信息。188bet安卓APP

查询参数名称 必需的 描述
candidate_ids 是的 逗号分隔的候选人ID列表(例如123,456)

响应参数

响应始终是一系列对象,即使只有一个candidate_id提供。

属性名 类型 描述
id 整数 候选人的ID
external_id 细绳 初始候选创建请求中提供的外部ID。如果请求与外部实体没有关联的候选人的状态,则可以为空。
申请[] 数组 一个包含0个或多个应用程序的数组,表示该候选人已应用的作业。每个应用程序都需要每个子元素。
applications.id. 整数 应用程序的ID。
applications.job 细绳 该应用程序的作业姓名适用于(例如“软件开发人员)。
applications.status 细绳 候选人的当前状态。必须是“被拒绝”之一“活跃”或“雇用”。
applications.stage 细绳 应聘者当前的面试阶段(例如“招聘人员电话筛选”)。
applications.profile_url. 细绳 一个网址到候选人在温室的个人资料。188bet安卓APP你必须登录到Greenhouse才能查看资料。188bet安卓APP

职位的候选人

卷曲-X帖子'https://api.188bet安卓APPgreenhouse.io/v1/partner/candidates'- h“授权:基本MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6”- h“内容类型:应用程序/ JSON”
{“前景”“真正的”“first_name”“哈利”“姓”“波特”“公司”“霍格沃茨”“标题”“学生”“简历”“https://hogwarts.com/resume”“电话号码”[{“电话号码”“123-456-7890”“类型”“家”}),“电子邮件”[{“电子邮件”“hpotter@hogwarts.edu”“类型”“其他”}),“社交媒体”[{“url”“https://twitter.com/hp”}),“网站”[{“url”“https://harrypotter.com”“类型”“博客”}),“地址”[{“地址”“4女贞博士”“类型”“家”}),“job_id”12345“external_id”“24680”“笔记”“善于Quiddich”“prospect_pool_id”123“prospect_pool_stage_id”456“prospect_owner_email”“prospect_ownsers_email@example.com”}

API的反应

{“id”12345“application_id”17681532“external_id”“24680”“个人资料网址”“https://app.188bet安卓APPgreenhouse.io/people/17681532?application_id = 26234709 "}

创建一个或多个候选人或潜在客户

文章https://api.gre188bet安卓APPenhouse.io/v1/partner/candidates

范围:candidates.create

请求参数

属性名 类型 必需的 描述
前景 布尔 没有 如果这个候选人应该是一个潜在的候选人,这是正确的。该组织必须能够创造前景设置这一领域。(默认值是真实的)
Job_id. 整数 混合 只有当前景不正确时才需要。这个候选人或潜在人选应该加入的工作的ID。
细绳 是的
last_name 细绳 是的
external_id 细绳 是的 应用程序系统中该候选人的唯一id。
公司 细绳 没有 候选人目前的公司
标题 细绳 没有 候选人的当前标题
恢复 细绳 没有 URL到候选人的简历。188bet安卓APPGreenhouse将尝试从这个URL摄取文档,并将其添加到候选记录中。
phone_number [] 数组 没有
phone_numbers.phone_number 细绳 混合 只有在包含Phone_Number时才需要。
phone_numbers.type. 细绳 混合 必须是“移动”,“家”,“工作”或“其他”。只有在包含Phone_Number时才需要。
电子邮件[] 数组 没有
emails.email 细绳 混合 注意:仅在包含电子邮件时才需要。
电子邮件.Type. 细绳 混合 必须是“个人”、“工作”或“其他”。只有包含电子邮件时才需要。
地址[] 数组 没有
地址.Address. 细绳 混合 一个自由格式的文本块,可以包含换行符(" \n ")。只有在包含地址时才需要。
addresses.type 细绳 混合 必须是“家”,“工作”或“其他”。只有在包含地址时才需要。
social_media [] 数组 没有
social_media.url 细绳 混合 注意:仅在包含社交媒体URL时才需要。
网站[] 数组 没有
网址 细绳 混合 注:只有在包含网站时才需要。
网站.Type. 细绳 混合 必须是“个人”、“公司”、“投资组合”、“博客”或“其他”。只有网站被包括时才需要。
推荐人 对象 没有 如果存在,则此值将用于填充候选申请的“获取信用”字段。如果省略,将填充当前用户的信息的“获取信用”字段。
referrer.email 细绳 混合 如果可能,用于将此引用者与现有的温室用户匹配。188bet安卓APP只有在包括referrer时才需要。
referrer.first_name.first_name. 细绳 混合 用于创建一个新的' Referrer '在温室如果Referrer。188bet安卓APP电子邮件与现有用户不匹配。只有在包括referrer时才需要。
referrer.last_name 细绳 混合 用于创建一个新的' Referrer '在温室如果Referrer。188bet安卓APP电子邮件与现有用户不匹配。只有在包括referrer时才需要。
笔记 细绳 没有 关于这个候选人的自由形式的纯文本笔记。一种使用方法是发送API无法作为结构化数据捕获的二级信息。例如:“技能:Java, c++, Python”
招手_Pool_id. 整数 混合 用来将前景放在潜在客户池中的展望。只有在包含propect_pool_stage_id时才需要。必须将“潜在客户”属性设置为真实。
prospect_pool_stage_id. 整数 没有 用来将前景池阶段的前景与此ID展开。舞台必须属于ProSpect_Pool_ID中提供的展望池。必须将“潜在客户”属性设置为真实。
prospect_owner_email 细绳 没有 用于通过提供Greenhouse中存在的有效用户的电子邮件为潜在客户设置潜在客户所有者。188bet安卓APP必须将“潜在客户”属性设置为真实。

响应参数

如果提供单个对象或提供数组,则API将使用单个对象或对象数组进行响应。

属性名 类型 描述
id 整数 温室新创建的候选人的身份。188bet安卓APP
application_id 整数 在Greenhouse中隐式创建的应用程序的ID。188bet安卓APP
external_id 细绳 您请求中提供的外部ID。
profile_url 细绳 候选人在温室内的个人资料的URL。188bet安卓APP用户必须签名为温室以查看配置文件。188bet安卓APP

当前用户

检索当前用户

旋度'https://api.188bet安卓APPgreenhouse.io/v1/partner/current_user'- h“授权:基本MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6”

API的反应

{“full_name”“罗恩韦斯莱”“first_name”“罗恩。”“姓”“韦斯莱”“电子邮件”“rweasley@hogwarts.edu”“id”1234.}

检索有关当前用户的详细信息

获取https://api.gr188bet安卓APPeenhouse.io/v1/partner/current_user.

请求参数

这个请求仅仅是URL。它没有参数。

响应参数

属性名 类型 描述
full_name 细绳 当前用户的全名
细绳 当前用户的名字
last_name 细绳 当前用户的姓
电子邮件 细绳 与当前用户关联的电子邮件地址
id 整数 当前用户ID

职位

检索工作

旋度“https://api.188bet安卓APPgreenhouse.io/v1/partner/jobs”- h“授权:基本MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6”

API的反应

[{“id”146859“名称”“傲罗”“状态”“打开”“公共”真正的},{“id”150050“名称”“教授”“状态”“打开”“公共”真正的},{“id”147886.“名称”“看护人”“状态”“打开”“公共”错误的},]

检索当前用户可见的作业,包括其组织公共职业页面上列出的所有作业和用户可以访问的未发布的作业。

得到https://api.gr188bet安卓APPeenhouse.io/v1/partner/jobs

范围:jobs.view

请求参数

这个请求仅仅是URL。它没有参数。

响应参数

属性名 类型 描述
id 整数 工作的身份。
的名字 细绳 温室里的名字,不一定是公共招聘板上的名字。188bet安卓APP
状态 细绳 总是“开放”。
上市 布尔 如果这份工作有目前居住在任何工作委员会的任何工作职位,则为真。

跟踪链接

邮政跟踪链接

卷曲-X帖子“https://api.188bet安卓APPgreenhouse.io/v1/partner/tracking_link”- h“授权:基本MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6”- h“内容类型:应用程序/ JSON”
{“job_id”12345}

API的反应

{“tracking_link”“http://grnh.se/yvj0bj”“工作”“傲罗”“源”“校园招聘”118金博宝“推荐人”“赫敏·格兰杰”}

为特定作业创建新的跟踪链接。使用此跟踪链接的候选应用程序将自动将其源设置为您的应用程序,并将其引用设置为当前用户。

post https://api.188bet安卓APPgreenhouse.io/v1/partner/tracking_link.

请求参数

属性名 类型 必需的
Job_id. 整数 是的

响应参数

属性名 类型 描述
tracking_link 细绳 新创建的跟踪链接URL。
工作 细绳 与此跟踪链接绑定的作业的名称。
细绳 与此跟踪链接相关的源的名称(例如,应用程序的名称)。
推荐人 细绳 绑定到此跟踪链接的用户名。

前景池

检索前景池

旋度“https://api.188bet安卓APPgreenhouse.io/v1/partner/prospect_pools”- h“授权:基本MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6”

API的反应

[{“id”123“名称”“冷外展:被称为““阶段”[{“id”1957“名称”“没有联系”},{“id”1958“名称”“联系”},{“id”1959“名称”“1st。跟进发送”},{“id”1960“名称”“第二次跟进发送”},{“id”1961“名称”“在讨论中”}]},{“id”456“名称”“冷外展:采购”“阶段”[{“id”1962“名称”“没有联系”},{“id”1963“名称”“联系”},{“id”1964“名称”“1st。跟进发送”},{“id”1965“名称”“第二次跟进发送”},{“id”1966“名称”“在讨论中”}]}]

检索前景池及其阶段为当前用户的组织。

得到https://api.gr188bet安卓APPeenhouse.io/v1/partner/prospect_pools

范围:前景pools.view_

请求参数

这个请求仅仅是URL。它没有参数。

响应参数

属性名 类型 描述
id 整数 前景池的ID。
的名字 细绳 展望池的名称。
阶段 对象 具有勘探池id和勘探池名称的勘探池。stage的列表将按照配置在Greenhouse中相同的方式进行排序。188bet安卓APP

错误

{“错误”[{“消息”“您的请求包含了无效的JSON。”“场地”“电子邮件”}]}

成功的API响应将具有200级HTTP状态代码。如果在处理您的请求时出现问题,则会使用4xx或5xx级状态代码收到响应,如下所示:

状态码 描述
400 您的请求包括无效的JSON。
401 你尚未经过身份验证。
403 您已经通过身份验证,但是您的Greenhouse用户没有权限访问该资源。188bet安卓APP
404 找不到您要求的资源。
5 xx 我们这边出了差错。如果问题仍然存在,您可以稍后重试或联系技术支持。

错误的属性

属性名 类型 必需的 描述
错误[] 数组 是的
errors.message 细绳 是的 描述错误的消息。这是用于调试目的,不打算显示给最终用户。在编程中不应该依赖确切的文本。
错误。菲尔德 细绳 没有 如果适用,则造成错误的请求中的违规字段。