1. Authentication

要使用SignalHire API,首先你需要在 网站,并在这里创建一个API密钥 http://zatwq.chrisandsandy.net/integrations.

API密钥应保密,避免与他人共享. 共享SignalHire API密钥将允许其他人使用您的付费API调用SignalHire API credits.

2. HTTP响应头

剩余的总积分可以在HTTP响应头中找到 X-Credits-Left. 或者使用特殊的 API method.

3. API请求的HTTP响应代码

SignalHire API还返回以下HTTP状态码 指示请求的成功或失败.

  • 200 —请求成功,数据为 collected.
  • 201 —请求被接受,服务器开始运行 collect data.
  • 204 -请求仍在处理中.
  • 401 -服务器无法验证您的身份验证 use API. 请检查API key是否正确.
  • 402 -你的信用额度快用完了.
  • 403 -您的帐户已被禁用或您要求 不是你请求的状态
  • 404 -请求的API无法在服务器或 您给出无效的json数据或您请求不存在请求的状态.
  • 406 -你提供的物品超过了允许的最大值 金额(现在上限为100)
  • 422 -服务器无法理解发送到的请求 it. 这是一种如果参数传递错误就会发生的响应.
  • 500 -服务器内部错误.
4. 通过使用回调url请求个人数据

回调url是由客户端应用程序提供的url Developer.

API endpoint - POST http://zatwq.chrisandsandy.net/api/v1/candidate/search

ParameterPlaceTypeDescriptionExample
apikeyRequest headerString, required的秘密API密钥 验证请求apikey: testapikey
itemsRequest bodyJson字符串,必需LinkedIn的url数组,电子邮件或 phones“项目”:[" http://www.linkedin.com/in/url1", "test@email.Com ", "+44 0 808 189 3171"]
callbackUrlRequest bodyString, required回调url在您的域名将 一旦搜索请求被处理,SignalHire就会POST请求."callbackUrl": "http://www.yourdomain.com/yourUrl"

请求和响应示例

它应该像这样响应: {"requestId":1} and status code 201.

请求和响应示例

如果回调url返回,则认为数据发布成功 200 HTTP response. 如果回调url在初始报告期间没有响应,或者无法响应 连接成功,将重试3次. 如果在重试过程中回调url返回200失败,则返回 是否会被视为失败并被丢弃以进行进一步尝试.

5. 响应体状态

Status "success" indicates that 收集个人数据并准备返回. Status "failed" 指示服务器找不到关于候选的任何内容, 例如,因为给定LinkedIn的url是 not valid. 如果使用了所有联系人积分,返回的状态将是 “credits_are_over” 所有候选人.

6. 配置文件数据示例
7. 获得剩余学分法

API endpoint - GET http://zatwq.chrisandsandy.net/api/v1/credits

Request parameters

ParameterPlaceTypeDescriptionExample
apikeyRequest headerString, required的秘密API密钥 验证请求apikey: testapikey

请求和响应示例

它应该像这样响应: {"credits":27} and status code 201.

通过使用SignalHire API,您同意我们的 Terms of Use, Privacy Policy, and GDPR Compliance

BACK TO TOP