API开放平台

TIP

# 开发前必读

# 概述

为了帮助企业打通勤策和企业内部CRM、HR、ERP等系统之间的数据通道， 勤策平台向所有客户提供服务API接口和数据推送服务。

1)服务端API接口是由企业管理系统向勤策主动发起调用请求，实现系统之间数据交互。参考说明：业务接口格式规范 (opens new window)

2)数据推送服务是勤策平台在业务数据发生时向企业管理系统发起调用请求，将数据同步到企业管理系统。参考说明：推送接口格式规范 (opens new window)

# 如何申请

企业接入申请是由企业管理员登录WEB端管理后台“系统管理”-“集成管理”-“API管理”中开通。开通后将会生成授权信息OpenAPI请求REGION地址、OPENID和APPKEY。 OpenAPI请求REGION是企业账号所在数据中心地址，OPENID是企业接入的唯一凭证， APPKEY为请求接入的授权密钥。为了数据安全,所有请求数据需要经过密钥加密生成数据签名后提交到勤策平台。 OPENID、APPKEY是由企业管理员或维护和授权。REGION地址是由企业所在数据中心决定有可能会发生变更。企业在接入时这几项配置最好做成配置参数形式以便必要时修改。

# 开发文档阅读说明

文档的阅读次序：先阅读一遍基本概念介绍和接口格式规范，然后再独立查看各个功能块文档说明。

所有的接口需使用HTTPS协议、JSON数据格式、UTF8编码, 数据长度也是按照标准数据库字段的描述，如有和您使用的数据库不一样请注意转换！接口说明格式如下：

请求方式：POST（HTTPS）
请求头：Content-Type: application/json;charset=utf-8
请求地址：https://{region}/api/organization/v1/queryOrganization/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求示例：...
参数说明：...
响应示例：...
参数说明：...

  1. 请求方式：标明接口调用的HTTP方法，只接受HttpPost请求。所有的请求都为https协议。
  2. 请求地址：参数中 {} 中的单词，表示为需要替换的变量。在上面的例子中 region、openid 、timestamp 、digest 、 msg_id为需要替换的变量，根据实际获取值更新。假如，这里我们获取到的授权信息为region=https://openapi.qince.region2.com，openid=5465103569540931532，timestamp=20150806142836，digest=74267bf0cae0998a719879ec9b3c7780，msg_id=ORG00001
    那么上述的请求在发送时为：

https://openapi.region2.qince.com/api/organization/v1/queryOrganization/5465103569540931532/
20150806142836/74267bf0cae0998a719879ec9b3c7780/ORG00001

  1. 请求示例/参数说明：标明请求参数示例及说明，参数说明包括字段含义、取值范围，开发者在设计数据结构时，应参考该定义范围。请求示例仅供参考，具体以参数说明为准。
  2. 响应示例/参数说明：标明返回参数示例及说明。特别留意，所有接口返回包里都有errcode、errmsg。开发者需根据errcode是否为0判断是否调用成功（errcode意义请见错误码说明 (opens new window)）。而errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据。

# 基本调试方法

  1. 勤策提供了在线调试功能，可以借助此功能排查问题原因。
  2. 使用postman工具调试api接口。
    参考说明：简易教程 (opens new window)

# 接口代码参考示例

接口代码参考示例 (opens new window)里面有多种开发语言调用接口示例，开发前建议仔细阅读一遍

# 常见问题 - FAQ

开发调试过程中遇到问题首先去常见问题 - FAQ (opens new window)中查看一下，里面提供了一些常见问题的解决方案

← 基本概念介绍 →