【返回Z平台-帮助文档-首页】
本章节介绍Z平台中，对外开发接口的开发方式，对外开放接口主要用于与第三方系统进行数据通信，同时为前端项目如【APP】【各种小程序】【前端网站】提供数据接口服务。同时配合【接口密钥】功能来进行接口访问权限的多级控制。
目录
需求介绍
根据项目需求，需要开发两个HTTP接口，拉口需要如下：
Z平台接口包括两个类型接口，【SQL配置类型接口】与【自定义程序接口】，为两演示两种接口的开发方法。
下方“接口1”，会通过SQL配置类型接口的方式进行开发，“接口2”，会通过自定义程序方式进行开发。
接口1：根据客户手机号，查询客户拜访记录。
接口2：根据客户公司名称，查询该公司所有被拜访客户记录。
接口开发
首先，运行【系统管理--开发--HTTP接口】功能
SQL配置类型接口
在HTTP接口列表页面，点击【新增】打开新增页面，并在页面填写接口相关参数。
所属项目：自行选择。根据实际情况选择，演示环境选择test项目
接口标识：英文标识，系统内不可重复。用于接口调用使用
名称：中文接口标识
是否启用：系统默认为“否”，等待开发完成后可设置为启用状态，外面程序就可以设置该接口了。
接口类型：选择【SQL接口】
操作类型：根据SQL类型进行选择，本接口SQL 为select类型，所以选择为【查询】
SQL语句：编写查询SQL SQL中变量的写法为 #{#变量名}
SELECT c.customer_company, c.customer_name, c.customer_tel, u.user_name, d.d_time FROM test_visit_form c INNER JOIN test_visit_form_times d ON c.zid = d.pid LEFT JOIN z_user u ON d.d_user = u.zid WHERE c.customer_tel = '#{#tel}'
保存后，需要定义SQL中的变量信息‘#{#tel}’ 手机号参数，用于接口调用时传入的参数
通过以上的设置，SQL类型接口就开发完成了。其它插入，修改，删除类型SQL与查询类型相同，请自行体验。
自定义程序接口
自定义程序接口与的配置过程与SQL接口基本相同，只是【接口类型】需要选择自定义程序接口。
需要注意的是，自定义程序类型接口在保存后，会自动生成接口实体JAVA代码，生成代码的路径与所选【所属项目】和【接口标识】有关。
接口类生成路径: com.futvan.z.httpservices.项目ID.接口标识+HttpService.java
重点：自定义程序接口返回类型必须为 com.futvan.z.framework.common.bean.Result类的json数据
Result类介绍
code: 返回状态 | com.futvan.z.framework.common.bean.Code【枚举类：SUCCESS ERROR】
msg：返回信息 | String
data：返回信息 | T
接口权限密钥
要在外部系统访问接口，必须有合法接口访问密钥。创建密钥方式先运行【系统管理--设置--接口密钥】
【新增】一条密钥记录
名称：自定义中文名称，用于描述密钥名称。例如：为XXX项目设置的接口访问密钥
同时，可以设置此密钥的授权访问IP或域名，设置IP或域名后，其它地址将无法通过该密钥访问接口
接口访问测试
以Google Chrome浏览器做为测试工具进行接口访问。
测试接口1：
http://127.0.0.1/z/httpservices?
&accesskeysecret=fqwehdfgjfghjfghjfghjfghjwrertwert
&serviceid=get_test_visit_form_list
accesskeyid: 密钥keyID
accesskeysecret: 密钥密码
serviceid ： 接口标识
tel : 定义的客户手机号变量
设置结果 ：
返回结果：为成功
返回信息：空
返回数据：查询返回的列表
测试接口2：
自定义接口在调用时，直接以接口标识进行接口调用，和块和SQL接口是有区别的。
http://127.0.0.1/z/get_test_visit_form_list_for_id?
&accesskeysecret=fqwehdfgjfghjfghjfghjfghjwrertwert
get_test_visit_form_list_for_id：接口标识
customer_company：变量参数
调用接口：
返回结果：成功
返回信息：ok
返回数据：查询返回的列表
