本文提供了 Moka People 所有接口 API，调用 API 接口前，需了解 开发须知及调用流程 ，供开发者参考。
组织架构
业务描述 | 用于保持双方组织架构信息保持一致 | |
前置信息确认 | 确认数据逻辑（全量、增量，修改、删除、查询） | |
\ | 接口地址 | 说明 |
v2/departments | Moka 系统中会根据请求的列表对当前系统中的部门进行同步（新增，更新，标记删除）。 | |
v2/departments/sync/incremental | 新增组织架构 注意：组织架构增量同步必须使用POST请求，如果使用PUT请求，为全量同步，请求中未提供的部门，部门将标记为已删除。 | |
v2/departments | 对指定部门更新组织架构信息 注意： 以department_code为主键进行更新，如果需要更新department_code时，需要传入department_id，将以department_id为主键更新department_code。 | |
v1/departments | 提供部门增加删除标识（已删除部门不合并到另一个部门）和删除部门（删除部门并将已删除部门合并到其他部门） | |
v1/position/departmentUser | 为指定部门绑定职务以及该职位的成员 | |
用户信息
业务描述 | 用于保持双方用户信息保持一致 | |
前置信息确认 |
| |
\ | 接口地址 | 说明 |
v2/users/syncInfo | Moka 系统中会根据请求的列表对当前系统中的人员进行同步（新增，更新，标记删除） | |
v1/users/list | 分页查询Moka用户信息 | |
v1/users/roles | 查询用户的角色信息 | |
职务
业务描述 | Moka 系统中会根据请求的列表对当前系统中的职务进行同步（新增，更新，标记删除）。 同步以positionCode为主键，与系统中部门positionCode进行对比： 1、当前系统没有，同步时有：新增一个职务 2、当前系统有，同步时也有：更新已经存在的职务信息。如果同步时有，当前系统职务状态标识为删除，更新后，状态改为正常。 3、当前系统有，同步时没有时：部门打标已删除，需要手动进入 Moka 系统中将该部门合并到其他部门进行删除。 | |
前置信息确认 |
| |
\ | 接口地址 | 说明 |
| v1/positions/syncInfo |
|
门店
业务描述 |
| |
前置信息确认 |
| |
\ | 接口地址 | 说明 |
v1/get_stores | 拉取门店列表 | |
v1/stores | Moka 系统中会根据请求的列表中每个门店信息对当前系统中的门店进行同步（新增，更新，停用，启用）。 | |
v1/store/changeJobManagerOrAssistantByStore |
| |
招聘需求信息
业务描述 | 保持双方系统中招聘需求保持一致 | |
前置信息确认 | 确认企业侧接口返回逻辑，是否涉及更新、取消、删除 | |
\ | 接口地址 | 说明 |
v1/headcount | 同步信息内包含组织架构、职位id信息需要到相关接口单独获取 | |
v1/headcount/{hcId} | 更新招聘需求信息，包括自定义字段 | |
v1/headcount/{hcId} | 删除相关招聘需求 | |
v1/headcount/minimal_headcounts | 根据招聘模式（校招&社招）获取招聘需求基本信息列表 | |
v1/headcount/{hcId} | 根据招聘需求id获取招聘需求的详细信息 | |
v1/headcounts | 获取指定状态的招聘需求列表 | |
v1/headcount_status/count | 返回不同阶段的招聘需求数量（complete、suspend、unstart） | |
v1/hc_fields | 获取招聘需求自定义字段 | |
v1/data/headcounts | 根据数据的开始时间获取招聘需求 | |
职位信息
业务描述 | 保持双方系统中职位信息保持一致 | |
前置信息确认 | 职级的创建、职能的绑定 | |
\ | 接口地址 | 说明 |
v1/jobs-fields | 根据招聘模式查询职位字段接口主要用户查询系统内已创建的职位字段，包括系统默认字段和自定义字段 | |
v1/jobs?currentHireMode=1 | 通过接口直接在Moka系统中创建职位；创建职位时间即为开始招聘时间 | |
v1/jobs/{jobId} | 通过接口更新系统中已存在的职位信息 | |
v1/jobs/getJobs | 通过接口查询系统中已存在的职位信息 | |
v1/pipelines/list | 获取招聘流程列表 | |
v1/data/jobs | 获取职位信息 | |
v1/data/job_stages | 该接口将返回指定职位下，所有可用阶段信息 | |
v1/job_priority | 获取职位优先级的列表 | |
v1/job_ranks | 获取企业职位级别，GET请求 | |
v1/job_ranks | 创建企业职位级别，POST请求 | |
v1/job_ranks/:id | 更新企业职位级别，PUT请求 | |
v1/job_ranks/:id | 删除企业职位级别，DELETE请求 | |
v1/jobs/custom_fields?currentHireMode={currentHireMode} | 通过接口直接在Moka系统中创建职位的自定义字段，POST请求 | |
v1/jobs/custom_fields/{jobFieldId}?currentHireMode={currentHireMode} | 通过接口更新在Moka系统中创建职位的自定义字段，PUT请求 | |
v1/jobs/custom_fields/{jobFieldId}?currentHireMode={currentHireMode} | 通过接口删除在Moka系统中创建职位的自定义字段，DELETE请求 | |
v1/job-templates/list | 查询自定义招聘设置
| |
Offer信息
业务描述 |
| |
前置信息确认 |
| |
\ | 接口地址 | 说明 |
v1/create-offer | 传入Offer信息，创建一个Offer。需要与您企业对接的客户成功经理开启该功能 | |
v1/offers/offerFields/update | 用于对系统中已存在的offer进行更新，更新offer必审字段后，原Offer审批会失效，需要重新发起审批 | |
v1/listOfferTemplateByOrgId | 获取offer附件模板列表 | |
v1/offerApprovals?email={email}&period={period} | 根据用户的email和offer审批状态获取需要该用户审批的offer。 | |
v1/applications/offerApproval | 根据申请ID和状态更新offer审批结果,需要与您企业对接的客户成功经理开启外部审批功能 | |
v1/sendOffer | 根据applicationId发送offer | |
v1/offer/status?applicationId={applicationId}&accepted={accepted}&reasonId={reasonId} | 设置候选人Offer反馈状态，Moka 系统收到后将对应的申请标记为接受或拒绝。 | |
v2/offers/custom_fields | POST请求 | |
v1/offers/custom_field/create | POST请求 | |
v1/offers/custom_field/update | PUT请求 | |
v1/offers/custom_field/delete | DELETE请求 | |
v1/offer/getOfferAttachment |
| |
入离转正状态信息信息
业务描述 |
| |
前置信息确认 |
| |
\ | 接口地址 | 说明 |
v1/applications/{applicationId}/rejected | 将申请状态归档，并放入人才库。申请必须处于“待入职”阶段，并且不在人才库中。 | |
v1/applications/{applicationId}/hired | 根据候选人申请id。 | |
v1/applications/{applicationId}/corrected | 根据候选人申请id。 | |
v1/applications/{applicationId}/resign | 根据候选人申请id。 | |
Moka主动推送数据说明
业务描述 | Moka通过webhooks进行数据推送 | |
前置信息确认 |
| |
\ | 接口地址 | 说明 |
| 介绍什么是webhooks。如何设置webhooks。webhooks的安全保障(HTTP RESTful方式)。接收webhooks(HTTP RESTful方式)。回复webhooks(HTTP RESTful方式) | |
| 推送候选人信息目前在Moka中是由""导入EHR"按钮点击触发，如下图： | |
| 推送添加面试信息目前在Moka中是由添加面试完成确认按钮点击时触发 | |
面试信息同步
业务描述 | 用于推送面试信息同步到企业对接系统 | |
前置信息确认 | 触发节点：推送添加面试信息目前在Moka中是由添加面试完成确认按钮点击时触发 对接概要：面试信息创建、修改、删除调用的是同一接口地址 | |
\ | 接口地址 | 说明 |
v1/interview/create |
| |
v1/interviews?startDate={startDate}&endDate={endDate} | 拉取从startDate（包含）至endDate（包含）的面试列表 列表内容为可读的中文描述信息 | |
m/interview-signin/{orgId}?phone={Phone} | 第三方面试签到系统需要跳转至moka面试签到页面时使用。 | |
v1/data/interviewer_feedbacks |
| |
v1/addFeedbackTemplates | 添加对应的面试评价表 | |
v1/updateFeedbackTemplates | 更新对应的面试评价表 | |
v1/deleteFeedbackTemplates | 删除对应的面试评价表 | |
内推账户
业务描述 |
| |
前置信息确认 |
| |
\ | 接口地址 | 说明 |
v1/user/recommend_account/search | 单次查询只允许查询20个用户 | |
v1/user/recommend_account/wallet_balance_changes |
| |
上传附件
业务描述 | 上传附件接口 | |
前置信息确认 |
| |
\ | 接口地址 | 说明 |
v1/file/upload | 上传附件接口 | |
门店
业务描述 | 上传附件接口 | |
前置信息确认 |
| |
\ | 接口地址 | 说明 |
v1/get_stores | 拉取门店列表 | |
v1/stores | Moka 系统中会根据请求的列表中每个门店信息对当前系统中的门店进行同步（新增，更新，停用，启用）。 | |
v1/store/changeJobManagerOrAssistantByStore |
| |
招聘官网
业务描述 | 此部分API主要用于获取招聘官网中的职位信息，以及投递简历到一个职位。 | |
前置信息确认 |
| |
\ | 接口地址 | 说明 |
v1/website/list | 获取企业在招聘官网模块处所有创建的官网信息列表 | |
v1/jobs/{orgId} | 获取招聘官网上的职位列表 | |
v1/jobs/{orgId}/{jobId} | 获取单个职位的所有信息。 | |
v1/jobs/{orgId}/{jobId}/apply | 返回新申请的信息 这个API支持两种请求格式，分别是multipart/form-data方式和json方式。 如果你需要上传简历或者附件文件，就必须使用multipart/form-data方式。 使用multipart/form-data方式上传的简历文件会经过我们的简历解析服务做处理。 此API需要验证身份信息，验证方式请参考请求验证/Auth部分。 注意：该模块字段是否必填取决于系统内字段属性设置 | |
v1/applications/{applicationId} | 获取一个申请的状态，包括是否被拒绝，是否已入职，是否在流程中 ，以及当前阶段的名称等。 | |
v1/jobs-groupedby-location/{orgId} | 获取职位地址列表。 注意：可用于职位列表接口查询用的id是locationRows里的id，因为同一个北京市下可能会有多个办公地址，用右边的接口举例，需要查询北京市下的职位，需要给职位接口传locationIds:[445, 446] | |
v1/jobs-groupedby-zhineng/{orgId} | 获取职位职能列表。 注意：数组里的id是可以用过过滤职位列表接口里的；用右边的接口举例，需要查询技术类下的职位，需要给职位接口传zhinengId:2873 | |
pc端 https://app.mokahr.com/apply/{orgId}/{siteId}#/job/{jobId}/apply?pure=1 移动端 https://app.mokahr.com/m/apply/{orgId}/{siteId}#/job/{jobId}/select?pure=1 | 纯净版官网申请表，去除了候选人申请页面的导航和其他moka元素，只包含申请表单与渠道导入简历部分，可通过iframe方式嵌入自研官网。 有pc端和移动端的区分。只需在原来的普通申请页面的url加上query pure=1 | |
企业信息
业务描述 | 上传附件接口 | |
前置信息确认 |
| |
\ | 接口地址 | 说明 |
v1/locations | 获取企业地点列表信息 | |
locations/v2/batch_create_locations | 批量新增公司地址 通过addressCode新增公司地址 addressCode已存在：跳过并报错 addressCode不存在：新增 部门不支持向下级联 | |
locations/v2/batch_delete_locations | 批量删除公司地址 通过addressCode删除公司地址 addressCode已存在：删除 addressCode不存在：跳过，并报错 | |
locations/v2/batch_update_locations | 批量更新公司地址 通过addressCode更新公司地址 addressCode已存在：更新 addressCode不存在：跳过，并报错 部门不支持级联 | |
locations/v2/batch_update_locations | 批量获取公司地址 (1）V1名称更新：“获取企业地点列表”改为“获取公司地址” (2）新增“获取公司地址”V2接口 通过addressType查询对应类型的公司地址 有则返回 无则跳过，并报错 | |
候选人
业务描述 | 此部分API主要用于获取系统中配置的候选人自定义模块以及自定义字段信息 | |
前置信息确认 |
| |
\ | 接口地址 | 说明 |
v2/data/ehrApplications |
| |
v1/data/moved_applications | 该接口将返回指定条件中所有阶段内的全部候选人信息 首次调用时，会返回指定阶段中所有候选人信息，然后标记候选人，标记后在候选人移动前将不能通过该接口获取到数据，后续如果该阶段中候选人移动，则可以重新获取到数据,每次最多返回100条数据。 本接口只返回基础信息，不会返回附件链接。 | |
v1/data/movedApplications | 该接口将返回指定条件中所有阶段内的全部候选人信息 | |
v1/candidates/custom_blocks | 获取配置的自定义模块列表 | |
v1/candidates/custom_fields | 获取配置的自定义字段列表 | |
v1/candidate/customField/update | 每次修改的字段数量不超过300个 | |
v1/data/applications | 获取候选人申请信息 | |
v1/applications/move_application_stage?applicationId={applicationId}&stageId={stageId} | 将申请移动到所在职位下的任一阶段。 | |
v1/blackCandidate | 拉黑候选人 | |
v2/pipelines/getPipelinesList |
| |
v2/stage/getStagesList |
| |
candidate/v1/getApplicationStates |
| |
v1/talentPool/blackList/remove |
| |
candidate/v1/get_handle_Result |
| |
candidate/v1/get_candidate_stage |
| |
人才库
业务描述 | 人才库数据对接 | |
前置信息确认 |
| |
\ | 接口地址 | 说明 |
v1/talentPool/list?hireMode=1 | 返回值为该企业下设置的人才库列表 | |
v1/talentPool/candidates?archivedAtStart=2019-06-01&archivedAtEnd=2019-11-01 | 返回值为该企业下人才库里候选人相关信息 分页返回一页20条数据 | |
v1/archiveReasons | 返回值为该企业下设置的所有拒绝原因，含系统默认和自定义 | |
v1/reserveOtherTalentPool | 移动/复制候选人到指定的人才库 | |
v1/archiveApplicationToTalentPool | 归档申请:是否发拒信功能 | |
v2/syncCandidates |
| |
猎头
业务描述 | 猎头公司和猎头顾问数据对接 | |
前置信息确认 |
| |
\ | 接口地址 | 说明 |
v1/headhunters/addCompany |
| |
v1/headhunters/updateCompany |
| |
v1/headhunters/getCompany |
| |
v1/headhunters/getContacts |
| |
v1/headhunters/addContacts |
| |
v1/headhunters/addContacts |
| |
单点登录
业务描述 | 实现从三方系统单点登录到Moka | |
前置信息确认 | 确定单点登录协议 | |
\ | 接口地址 | 说明 |
| CAS单点登录使用 CAS Protocol, 兼容 CAS protocol v2 和 CAS protocol v3 | |
| 开放授权的一个标准 | |
| MOKA通用单点登录,一种简单的单点登录 | |
