导航
壳牌

介绍

候选人摄取API使利用温室与谁共享相互客户提交潜在客户和候选人的合作伙伴。10bet网站开户

API允许合作伙伴:

  1. 将合作伙伴申请中的候选人发送到Greenhouse。10bet网站开户
  2. 检索候选人的当前阶段和状态。
  3. 检索允许温室用户操作的作业。10bet网站开户

注意:为了使用Candidate Ingestion API创建潜在客户,组织必须能够创建潜在客户。

验证

此API提供了两种认证方法:OAuth 2.0和基本验证。

通过OAuth 2.0进行认证

如果相互客户的用户在温室和合作伙伴系统中具有账户,则首选的身份验证方法是10bet网站开户OAuth 2.0。在这种情况下,合作伙伴将在其网站上放置集成选项,这将允许用户通过合作伙伴的应用程序对温室进行身份验证。10bet网站开户这类似于允许人们使用Facebook凭据注册网站。对于配置此操作的合作伙伴,他们必须提供带有以下信息的温室:10bet网站开户

  1. 应用名称:在Greenhouse中显示的应用程序名称。10bet网站开户
  2. 应用程序的URL:到主应用程序的URL。
  3. 回调URL:这是温室将发送身份验证用户的URL。10bet网站开户
  4. 形象标识:这是一个128x128的图像,将包含在权限模态中。

当Gree10bet网站开户nhouse收到此信息时,我们将向合作伙伴提供一个消费者密钥、一个消费者机密、一个令牌URL和一个授权URL。例如:

属性 示例值
消费者的关键 bmipe4kwf987654321grlg1nfk1234567ushvlod.
消费者秘密 LQdulabcdefghijklEZok2fE5xGzeBcDa123gNXtN
令牌网址 https://api.10bet网站开户greenhouse.io/oauth/token
授权URL. https://api.10bet网站开户greenhouse.io/ouuth/authorize.

合作伙伴应该使用此信息在其应用程序中启动OAuth 2.0流。请注意,客户用户可以在任何时候取消此操作。关于如何配置它的更多信息(包括样例Ruby Gem)可以找到在github上。

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

提示图片

一旦OAuth进程完成,并且用户授予合作伙伴访问他们在Greenhouse上的数据的权限,合作伙伴将收到一个访问令牌。10bet网站开户这个访问令牌必须包含在Authorization头中:

授权:持票人

通过基本验证进行身份验证

如果您的用户仅在温室中只有一个帐户,您将作为合作伙伴提交候选人(并且不由用户10bet网站开户提供),您可能希望通过HTTP基本身份验证进行身份验证。用户不必采取任何操作来授权您的应用程序来修改温室数据。10bet网站开户使用基本验证时,您需要为每个请求设置代表标题。该值应该是您代表您采取行动的用户的电子邮件地址。例如:

代表:john.smith@example.com

通常,这将是专门为此目的创建的服务用户。如果缺少此标题,或者温室无法识别地址,则API将发出a10bet网站开户401未经授权回复。应用程序还必须提供API密钥。通过Basic Auth,您将包含API键作为基本验证用户名,并且没有密码。由于在我们的情况下只需要提供用户名,因此您需要将A :(冒号)附加到API令牌,然后Base64对生成的字符串进行编码。这可以通过URL包括:

https:// :@ ap10bet网站开户i.greenhouse.io / v1 /合作伙伴/候选人

或作为授权标题:

授权:基本base64_encoded_api_key:

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

注意:使用Engestion API的功能将仅限于代表代表用户的权限

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

默认情况下,Site Admins可以访问所有的作业,而Job Admins/考官被分配给特定的作业。工作管理员/面试官只能通过分配给他们访问的API检索工作,或者在公司的工作面板上实时显示的工作。然而,他们可以增加候选人的工作,他们有机会,以及失业前景温室。10bet网站开户

因为所有用户权限都是基于工作的,为了从API中检索失业前景,Site Admins、Job Admins和面试官需要额外的Greenhouse权限来管理失业前景。10bet网站开户否则,它们只能添加前景,而不能检索它们。UI也是如此。

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

基本用户可以:*抢修工作有关当前用户的返回信息*创造前景在工作岗位上创造候选人

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

OAuth范围

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

一般考虑

除非另有说明,否则A​​PI方法通常符合以下内容:

摄入API更改日志

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

日期 描述
4月15日,2021 03:00:00 PM 添加全名ID到[获取Current_User]响应
2019年8月22日11:00:00 将更改日志和常规考虑部分添加到Engestion API文档中

考生

检索候选人

卷曲“https://api.10bet网站开户greenhouse.io/v1/partner/candidates”-H“授权:基本Mgqwmzfkodiyn2vhzme2mwrjmzc1ytzjmmuwnjdlmjq6”
{“candidate_ids”:17681532}

API响应

{“ID”:17681532,“名称”:《哈利波特》,“external_id”:“24680”,“应用程序”:({“ID”:59724,“工作”:“Auror”,“地位”:“积极的”,“阶段”:“申请审查”,“profile_url”:“https://app.10bet网站开户greenhouse.io/people/17681532?application_id=26234709”}]}

检索候选人的数据。注意,这个调用将只返回当前用户拥有查看权限的候选对象。

得到https://api.gr10bet网站开户eenhouse.io/v1/partner/candidates

范围:候选人

请求参数

该请求应包含单个查询参数,该参数指定逗号分隔的候选ID或单个候选ID列表。If you provide any candidate ids that don’t exist or to which you do not have access, this endpoint will ignore them and only return the candidates that exist to this API key or Bearer token, or will return an empty response if you have only supplied one candidate ID.

将返回一个空数组,以便“检索候选候选者”请求为以下使用情况下为单个候选ID:

  1. 权限在与用于验证请求的电子邮件地址相关联的温室用户帐户上进行10bet网站开户的更改(例如,已禁用或取消用户)。
  2. 候选人是在一份工作中,用户帐户/电子邮件地址无法访问。请注意,用户帐户必须至少是与候选ID关联的作业的作业管理员。如果作为展望添加,用户必须有权管理未附加的前景。
  3. 候选档案由组织手动删除。
  4. 候选资料的源是手动更改为与原始伙伴源不同的新源。
  5. 候选人已与生成新候选ID的另一个配置文件合并。

如果您想要更多有关您无法访问特定候选ID的更多信息,请联系客户以获取更多详细信息,因为无需组织拥有候选记录的组织许可,因此温室支持不会分享候选详细信息。10bet网站开户

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

响应参数

响应将始终是一个对象数组,即使只有一个Candidate_id.提供。

财产名称 类型 描述
ID 整数 候选人的身份证
External_id. 字符串 您的初始候选创建请求中提供的外部ID。如果您请求与外部实体无关的候选者的状态,则可以为null。
应用[] 大批 包含0或更多应用程序代表该候选者应用的作业的应用程序。每个应用程序都需要每个子元素。
applications.id 整数 应用程序的ID。
applications.job. 字符串 该应用程序的作业姓名适用于(例如“软件开发人员)。
applications.status. 字符串 候选人的当前状态。必须是“被拒绝”之一“活跃”或“雇用”。
Applications.stage. 字符串 申请人在面试管道中的当前阶段(例如“招聘人员屏幕”)。
applications.profile_url 字符串 候选人在温室中的一个URL。10bet网站开户您必须登录到温​​室以查看个人资料。10bet网站开户

发布候选人

卷曲-X帖子“https://api.10bet网站开户greenhouse.io/v1/partner/candidates”-H“授权:基本Mgqwmzfkodiyn2vhzme2mwrjmzc1ytzjmmuwnjdlmjq6”-H“application / json内容类型:
{“展望”:“真的”,“名”:“哈利”,“姓”:“波特”,“公司”:“霍格沃茨”,“标题”:“学生”,“恢复”:“https://hogwarts.com/resume”,“phone_number”:({“phone_number”:“123-456-7890”,“类型”:“家”}],“电子邮件”:({“电子邮件”:“hpotter@hogwarts.edu”,“类型”:“其他”}],“社交媒体”:({“URL”:“https://twitter.com/hp”}],“网站”:({“URL”:“https://harrypotter.com”,“类型”:“博客”}],“地址”:({“地址”:“4 privet dr”,“类型”:“家”}],“job_id”:12345.,“external_id”:“24680”,“笔记”:“擅长quiddich”,“prospect_pool_id”:123.,“prospect_pool_stage_id”:456.,“propaction_owner_email”:“prospect_owners_email@example.com”}

API响应

{“ID”:12345.,“application_id”:17681532,“external_id”:“24680”,“profile_url”:“https://app.10bet网站开户greenhouse.io/people/17681532?application_id=26234709”}

创建一个或多个候选人或前景

https://api.green10bet网站开户house.io/v1/partner/candidates.

范围:候选人。创建

请求参数

财产名称 类型 必需的 描述
展望 布尔基 如果这位候选人应该是一个前景,那就是真的。本组织必须能够创建要设置此字段的潜在客户。(默认:TRUE)
Job_id. 整数 混合 只有在潜在客户是假的情况下。应添加此候选人或前景的工作的身份证。
first_name 字符串 是的
字符串 是的
External_id. 字符串 是的 应用系统中此候选人的唯一ID。
公司 字符串 候选人现任公司
标题 字符串 候选人目前的标题
的简历 字符串 候选人简历的网址。10bet网站开户温室将尝试在此URL上摄取文档并将其添加到候选记录中。
电话号码[] 大批
phone_numbers.phone_number. 字符串 混合 只有包含phone_number时才需要。
phone_numbers.type. 字符串 混合 必须是“移动”、“家”、“工作”或“其他”。只有包含phone_number时才需要。
电子邮件[] 大批
电子邮件.Email. 字符串 混合 注:只有包含电子邮件时才需要。
emails.type 字符串 混合 必须是“个人”,“工作”或“其他”。只有在包含电子邮件时才需要。
地址[] 大批
地址.Address. 字符串 混合 一个免费表单文本块,其可能包括纽诺(“\ n”)。只有包含地址时才需要。
地址.Type. 字符串 混合 必须是“家”、“工作”或“其他”。只有包含地址时才需要。
社交媒体[] 大批
social_media.url. 字符串 混合 注意:只需要如果社会媒体url被包括。
网站[] 大批
website.url 字符串 混合 注意:仅在包含网站时才需要。
网站.Type. 字符串 混合 必须是“个人”,“公司”,“投资组合”,“博客”或“其他”。仅在包含网站时才需要。
介绍人 目的 如果存在,这个值将用于填充候选应用程序的“Who Gets Credit”字段。如果省略,“Who Gets Credit”字段将使用当前用户的信息填充。
推荐人.EMAIL. 字符串 混合 如果可能,用于将此引用者与现有的温室用户匹配。10bet网站开户只有在包含引用者时才需要。
referrer.first_name.first_name. 字符串 混合 如果推荐人与现有用户不匹配,则用于在温室中创建新的“推荐人”。10bet网站开户只有在包含引用者时才需要。
referrer.last_name.last_name. 字符串 混合 如果推荐人与现有用户不匹配,则用于在温室中创建新的“推荐人”。10bet网站开户只有在包含引用者时才需要。
笔记 字符串 关于这位候选人的自由形式的简单文字说明。使用这种方法是发送我们的API无法捕获为结构化数据的辅助信息。例如:“技能:java,c ++,python”
招手_Pool_id. 整数 混合 用于将带有此id的前景池中的前景。只有包含prospect_pool_stage_id时才需要。“prospect”属性必须设置为true。
prospect_pool_stage_id 整数 用于在prospect Pool Stage中使用此id放置一个prospect。该阶段必须属于prospect_pool_id中提供的勘探池。“prospect”属性必须设置为true。
招手_OWNER_EMAIL. 字符串 通过提供温室中存在的有效用户的电子邮件,用于将展望所有者设置为前景。10bet网站开户“prospect”属性必须设置为true。

响应参数

如果提供了单个对象,API将使用单个对象响应;如果提供了数组,则使用对象数组响应。

财产名称 类型 描述
ID 整数 温室里新创建的候选人的ID。10bet网站开户
application_id. 整数 温室内隐含地创建的应用程序的ID。10bet网站开户
External_id. 字符串 请求中提供的外部ID。
个人资料网址 字符串 一个网址到候选人的个人资料在温室。10bet网站开户用户必须登录到Greenhouse才能查看配置文件。10bet网站开户

当前用户

检索当前用户

卷曲“https://api.10bet网站开户greenhouse.io/v1/partner/current_user”-H“授权:基本Mgqwmzfkodiyn2vhzme2mwrjmzc1ytzjmmuwnjdlmjq6”

API响应

{“全名”:“罗恩韦斯莱”,“名”:“罗恩”,“姓”:“韦斯莱”,“电子邮件”:“rweasley@hogwarts.edu”,“ID”:1234}

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

得到https://api.gr10bet网站开户eenhouse.io/v1/partner/current_user

请求参数

此请求只是URL。它没有参数。

响应参数

财产名称 类型 描述
全名 字符串 当前用户的全名
first_name 字符串 当前用户的名字
字符串 当前用户的姓氏
电子邮件 字符串 与当前用户关联的电子邮件地址
ID 整数 当前用户的ID

工作

检索工作

卷曲'https://api.10bet网站开户greenhouse.io/v1/partner/jobs'-H“授权:基本Mgqwmzfkodiyn2vhzme2mwrjmzc1ytzjmmuwnjdlmjq6”

API响应

({“ID”:146859.,“名称”:“Auror”,“地位”:“开放”,“上市”:真的},{“ID”:150050,“名称”:“教授”,“地位”:“开放”,“上市”:真的},{“ID”:147886,“名称”:“看守”,“地位”:“开放”,“上市”:},]

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

获取https://api.gr10bet网站开户eenhouse.io/v1/partner/jobs.

范围:Jobs.view.

请求参数

此请求只是URL。它没有参数。

响应参数

财产名称 类型 描述
ID 整数 作业ID。
名称 字符串 温室中出现的名称,不一定如何在公共工作委员会上出现。10bet网站开户
地位 字符串 总是“开放”。
上市 布尔基 如果这份工作有目前居住在任何工作委员会的任何工作职位,则为真。

跟踪链接

邮政跟踪链接

卷曲-X帖子'https://api.10bet网站开户greenhouse.io/v1/partner/tracking_link'-H“授权:基本Mgqwmzfkodiyn2vhzme2mwrjmzc1ytzjmmuwnjdlmjq6”-H“application / json内容类型:
{“job_id”:12345.}

API响应

{“tracking_link”:“http://grnh.se/yvj0bj”,“工作”:“Auror”,“来源”:“校园招聘”,“referrer”:“赫敏·格兰杰”}

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

post https://api.10bet网站开户greenhouse.io/v1/partner/tracking_link.

请求参数

财产名称 类型 必需的
Job_id. 整数 是的

响应参数

财产名称 类型 描述
tracking_link. 字符串 新创建的跟踪链接URL。
工作 字符串 与此跟踪链接相关的作业的名称。
来源 字符串 与此跟踪链接绑定的源的名称(例如,您的应用程序的名称)。
介绍人 字符串 与此跟踪链路相关联的用户的名称。

展望池

检索前景池

卷曲'https://api.10bet网站开户greenhouse.io/v1/partner/pospect_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.gr10bet网站开户eenhouse.io/v1/partner/prospect_pools.

范围:前景pools.view_

请求参数

此请求只是URL。它没有参数。

响应参数

财产名称 类型 描述
ID 整数 远景池的ID。
名称 字符串 展望池的名称。
阶段 目的 属于展望池的阶段,具有舞台的ID和名称。阶段列表将与其配置为在温室中订购的方式相同的方式订购。10bet网站开户

错误

{“错误”:({“信息”:“您的请求包括无效的JSON。”,“场地”:“电子邮件”}]}

成功的API响应将有一个200级的HTTP状态码。如果在处理您的请求时出现问题,您将收到一个带有4xx或5xx级别状态码的响应,如下所示:

状态码 描述
400 您的请求包含了无效的JSON。
401. 你没有被证实。
403. 您已被身份验证,但您的温室用户无权对资源进行了权限。10bet网站开户
404. 找不到您请求的资源。
5xx. 我们最后有错误。如果问题仍然存在,您可以在稍后的时间或联系支持下重试。

错误属性

财产名称 类型 必需的 描述
错误[] 大批 是的
错误.. 字符串 是的 描述错误的消息。这是用于调试目的,并不旨在将显示给最终用户。不应以编程方式依赖确切的文本。
错误。菲尔德 字符串 请求中导致错误的违规字段(如果适用的话)。