# API接口常见问题 #### 1、爱客CRM钉钉版、励销CRM如何设置爱客CRM的、励销CRM的帐号密码呢？ 联系你的售后客服（如不清楚自己的售后客服是谁可咨询官方客服电话：爱客CRM：400-867-1101，励销CRM：400-618-0177）申请开通API对接。客服将对你的企业开放帐号密码设置功能。然后进入爱客CRM、励销CRM的设置中心—部门和用户，点击姓名旁边的编辑按钮，设置手机号，再点击姓名旁边的修改密码按钮，设置密码。通常对接API只需对超级管理员设置帐号密码。 爱客CRM钉钉版：   励销CRM：   设置好帐号密码后，先通过登录接口获取user\_token，然后在其他接口中带入user\_token、version\_code和device参数就可以调用其他接口了。 #### 2、接口地址是什么？ 爱客CRM独立版接口地址：https://api.ikcrm.com ，爱客CRM钉钉版接口地址： https://dingtalk.e.ikcrm.com ，励销CRM接口地址：https://e.lixiaocrm.com 。 如果是通过阿里云办公、阿里云套件或者钉钉自建应用开通的爱客CRM钉钉版，接口地址可通过在钉钉中登录爱客CRM，点击右上角的“在浏览器打开”，使用浏览器地址栏中显示的域名即可（不包含.com或.cn后面 / 后面部分）。 #### 3、如何获取user_token？ 调用登录接口/api/v2/auth/login获取user_token，注意登录接口是post请求。 #### 4、user_token的有效期是多久？ 一个帐号，PC端与移动端是可以同时在线user_token不会失效，若是有多部移动设备，切换移动设备登录（在移动设备重新登录）user_token就会更新，之前的user_token就失效了。 #### 5、全局参数中的version_code怎么填？ version_code填写3.13.0即可（后续版本的接口是向下兼容的），当前最新是3.22.4。 #### 6、全局参数中的device怎么填？ 如果是爱客CRM独立版，device填写ios或android；如果是爱客CRM钉钉版，device填写dingtalk；如果是励销CRM，device填写wxwork。 #### 7、调用登录接口提示device参数错误怎么办？ 请device参数没有填错，请检查参数是否是通过header传递的，应该通过body传递。  另外，推荐使用json格式：  #### 8、调登录接口提示帐号或密码错误怎么办？ 如果是爱客CRM独立版，请检查帐号或密码。如果是爱客CRM钉钉版，注意不是用钉钉帐号密码，而是需要用爱客CRM的帐号密码，详见**问题1**。如果是励销CRM，注意不是用企业微信帐号密码，而是需要用励销CRM的帐号密码，详见**问题1**。 #### 9、API接口有调用的频率限制吗？ 有的，为减轻调用接口对服务器的压力，避免对用户正常使用造成影响，接口限制调用频率为：1次/秒。 #### 10、接口返回错误码429是什么意思？ 返回错误码429或者提示Retry later表示超过接口调用频率限制了，建议控制调用接口频次为1次/秒。 #### 11、当爱客CRM、励销CRM中客户数据有更新时，可以回调给第三方吗？ 目前不支持回调。 #### 12、是否有PHP、Java、Python、C#、.Net等语言对接的Demo？ 没有。 #### 13、是否可以请求爱客CRM、励销CRM的技术人员帮忙对接？ 爱客CRM、励销CRM不提供对接服务，仅在必要时提供对接问题的咨询和解答，需要客户自己找开发人员对接。 #### 14、如何获取自定义业务字段？ 爱客CRM、励销CRM中很多模块都是支持自定义字段的，如果你使用了自定义字段，在创建或查询客户信息时，会得到一些字段可能不知道什么意思，对应系统中的哪个字段。这时就需要通过自定义业务字段接口，先获取自定义业务字段的信息。 根据接口地址/api/v2/custom_fields/by_group_all获取全部自定义业务字段，如需单独获取某类自定义字段使用以下接口：  比如这就是一个自定义字段的信息：  通过该信息我们得知该自定义字段的名称（用户看见的名称）叫“自定义字段2”，其在程序里面的唯一标识是datetime_asset_5d60f930 当我们获取客户信息时，就知道datetime_asset_5d60f930是指“自定义字段2”了。  #### 15、如何获取自定义业务参数？ 自定义业务参数配置请参考PC设置  在获取自定义业务字段中包含了相关自定义参数，如图  如果只想获取某个模块的自定义业务参数，请使用【接口地址/api/v2/field_maps/:entity_type 】  #### 16、如何创建客户？ 如果使用了业务模板，在创建客户时，需要优先选择客户业务类型，根据业务类型才能加载客户字段。 业务类型请使用接口地址/api/v2/business_templates接口传入entity_type=customer查询，如果返回status为0，表示启用了业务模板，然后在调用自定义业务字段接口，传入custom_field_template_id获取该模板下的字段列表，再调用创建客户接口，增加一个参数customer[custom_field_template_id]传入对应的业务类型id即可。 如果/api/v2/business_templates返回的所有结果的status都是1，表示没有可用的业务类型，需要让管理员启用至少1个业务类型。 如果/api/v2/business_templates返回的结果为空，表示没有启用业务模板，则先调用自定义业务字段接口获取字段，然后调用创建客户接口即可，不需要传入customer[custom_field_template_id]字段。 #### 17、可以批量创建客户吗？ 不能，只能写个循环调用创建客户接口的程序循环创建客户。 #### 18、如何查询客户是否重复？ 使用客户查重接口/api/v2/duplicates/search。 #### 19、如何获取一个客户的全部资料？ 先调用客户列表接口获得客户ID，再调用客户详情接口获得该客户全部资料。 以爱客CRM为例，涉及以下接口： http://test.ikcrm.com:8008/api_doc/#%E5%85%A8%E9%83%A8%E5%AE%A2%E6%88%B7%E5%88%97%E8%A1%A8 http://test.ikcrm.com:8008/api_doc/#%E5%AE%A2%E6%88%B7%E8%AF%A6%E6%83%85 #### 20、如何获取user_id？ 调用登录接口之后会返回当前用户的user_id，如果需要其他用户的user_id，可调用/api/v2/user/list获取。 以爱客CRM为例，涉及以下接口： http://test.ikcrm.com:8008/api_doc/#%E7%94%A8%E6%88%B7%E6%8E%A5%E5%8F%A3 #### 21、创建商机/合同时如何关联产品？ 因为关联产品可以关联多个因此在关联字段接口中，合同如【contract[product_assets_attributes]】 该字段是个数组结构 需要转化为数组如"contract[product_assets_attributes][]" 在数组中添加相关的参数 如关联产品的ID字段"contract[product_assets_attributes][][product_id]"，以此类推填写其他的相关参数 商机的创建也是如此，前缀需要换成opportunity类型 如: 如关联产品的ID字段 "opportunity[product_assets_attributes][][product_id]" #### 22、如何按照某项条件查询数据？ 1，根据接口【接口地址+/api/v2/::format/filter_sort_group】::format 请用对应的模块名称替换 如"customesr", "contacts", "opportunities", "contracts"，"leads" 2，通过第一步数据在调用【接口地址+/api/v2/::format/::filtter_type/filter_optionsp】 获取筛选项 其中::fitter_type使用第一步接口中“field_name”字段值替换 以爱客CRM为例，涉及以下接口： 如获取客户查询条件： 第一步：http://test.ikcrm.com:8008/api_doc/#%E5%AE%A2%E6%88%B7%E7%AD%9B%E9%80%89%E6%9D%A1%E4%BB%B6%E5%88%86%E7%BB%84 第二步：http://test.ikcrm.com:8008/api_doc/#%E5%AE%A2%E6%88%B7%E7%AD%9B%E9%80%89%E9%80%89%E9%A1%B9 #### 23、如何查询某段时间内新增的数据？ http://test.ikcrm.com:8008/api_doc/#%E5%85%A8%E9%83%A8%E5%AE%A2%E6%88%B7%E5%88%97%E8%A1%A8 如按照时间范围查找需要参数 ...&date=other&start_date=2018-01-01&end_date=2018-01-07 #### 24、如何查询某段时间内更新过的数据？ 根据对应的列表查询 查询条件为时间排序并通过时间区间过滤 时间格式参考如下：  如按照时间范围查找需要参数 ...&date=other&start_date=2018-01-01&end_date=2018-01-07 #### 25、如何查询某段时间内审批通过的合同？ 根据对应的列表查询 查询条件为时间排序并通过时间区间过滤 时间格式参考如下： 如按照时间范围查找需要参数 ...&date=other&start_date=2018-01-01&end_date=2018-01-07 审批通过的合同需要添加查询参数：approve_status=approved 更多查询条件请参考 **#### 22** #### 26、调用列表接口的时候，是返回全部的数据吗？ 不是，如果要查询全部的数据，需要循环调用接口查询不同page的数据，如page=1&per_page=20，per_page最大100。 #### 27、如何获取地区数据？ 先调用/api/v2/location/export传入klass_name=Province获取省份数据，再调用/api/v2/location/cities传入省份id获取该省份的城市，再调用/api/v2/location/districts传入城市id获取该城市的区县数据。 http://test.ikcrm.com:8008/api_doc/#%E8%BF%94%E5%9B%9E%E6%89%80%E6%9C%89%E7%9A%84%E6%95%B0%E6%8D%AE-%E6%89%80%E6%9C%89%E7%9C%81%E4%BB%BD #### 28、有一键删除全部客户的接口吗？ 没有，如果需要删除全部客户，可以循环调用删除客户接口循环删除。 http://test.ikcrm.com:8008/api_doc/#%E5%88%A0%E9%99%A4%E5%AE%A2%E6%88%B7 #### 29、如何导入客户数据到客户公海里面？ 先调用api/v2/common_customers/common_settings获取公海列表（公海id），然后调用创建公海客户接口api/v2/common_customers/:id #### 30、如何将销售的客户转移到客户公海里面？ 先调用api/v2/common_customers/common_settings获取公海列表（公海id），然后调用创建公海客户接口api/v2/common_customers/:id #### 31、如何查询某个客户是在公海还是不在公海？ 用查重接口，传查重字段的值，如果返回的结果中user_id有值表示有人负责，如果user_id为空表示在公海中。 #### 32、如何查询某个客户的跟进记录？ 使用查询跟进记录接口/api/v2/revisit_logs/new_index，传入实体和实体ID即可。 http://test.ikcrm.com:8008/api_doc/#%E8%B7%9F%E8%BF%9B%E5%88%97%E8%A1%A8 #### 33、如何为销售人员指派任务？ 使用创建任务接口，同时指定任务参与人的user_id，就会给该用户创建了任务。 #### 34、如何给客户上传附件？ 对客户上传附件，对应的是客户下的附件功能：  #### 35、如何给客户的自定义图片类型的字段上传图片？ 客户模块增加了一个图片类型的自定义业务字段，创建客户时对该图片字段上传图片，对应的是新增客户时上传图片：  #### 36、如何给合同的合同附件字段上传附件？ 对合同的合同附件字段上传附件，对应的是新增合同时上传合同附件：