# 开发前必读

# 接口说明

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

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

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

# 如何申请

企业接入申请是由企业管理员向客户经理提出开通申请,外勤365审核通过后将为企业分配授权信息OPENIDAPPKEY。OPENID是企业接入的唯一凭证, APPKEY为企业接入外勤365平台的密钥。为了数据安全,所有请求数据需要经过密钥加密生成数据签名后提交到外勤365平台。

# 开发文档阅读说明

文档的阅读次序,建议先阅读一遍开发指南,然后就可以独立查看各个功能块文档说明。

所有的接口需使用HTTPS协议、JSON数据格式、UTF8编码。接口说明格式如下:

请求方式:POST(HTTPS)
请求头:Content-Type: application/json;charset=utf-8
请求地址:https://openapi.waiqin365.com/api/organization/v1/queryOrganization/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求包体:
...
参数说明:
...
返回结果:
...
参数说明:
...

  1. 请求方式,标明接口调用的HTTP方法。所有的请求都为https协议。
  2. 请求包体/参数说明,标明请求参数示例及说明,参数说明包括字段含义、取值范围,开发者在设计数据结构时,应参考该定义范围。
  3. 返回结果/参数说明,标明返回参数示例及说明。所有接口在调用失败时返回包里都有errcode、errmsg。开发者需根据errcode存在且为0判断为成功,否则为失败(errcode意义请见错误码说明 (opens new window))。而errmsg仅作参考,后续可能会有变动,因此不可作为是否调用成功的判据。

# 基本调试方法

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

# 接口代码参考示例

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

# 常见问题 - FAQ

开发调试过程中遇到问题首先去常见问题 - FAQ (opens new window)中查找答案