phpapi接口设计

Ⅰ php中的API接口怎么写

api接口是具有的特定功能的程序代码块，作用是产生或者处理传输数据；
其存在的意义在于，不同语言之间的正常交流，包括iOS，java，PHP，C等，但是所有的程序语言都支持Json和Xml数据类型，所以接口产生数据基本都是json或者xml文件。
怎么写？
其实就是正常的功能类和方法，调用时产生需求功能对应的数据，仅此而已，在没有什么复杂的逻辑。

Ⅱ 开放平台API接口安全性设计——微信支付为例

API接口，类似 http://mypay.com/refund/order_id=123&mch_id=123 ，这个请求我以商户mch_id=123的身份给订单号为order_id=123退款，如果服务器不辩别请求发起者的身份直接做相应的操作，那是及其危险的。

一般的，在PC端，我们是通过加密的cookie来做会员的辨识和维持会话的；但是cookie是属于浏览器的本地存储功能。APP端不能用，所以我们得通过token参数来辨识会员；而这个token该如何处理呢？
延伸开来，接口的安全性主要围绕Token、Timestamp和Sign三个机制展开设计，保证接口的数据不会被篡改和重复调用。

一般来说，在前端对数据做加密或者前面，是不现实的。前后端使用HTTP协议进行交互的时候，由于HTTP报文为明文，所以通常情况下对于比较敏感的信息可以通过在前端加密，然后在后端解密实现"混淆"的效果，避免在传输过程中敏感信息的泄露（如，密码，证件信息等）。不过前端加密只能保证传输过程中信息是‘混淆’过的，对于高手来说，打个debugger，照样可以获取到数据，并不安全，所谓的前端加密只是稍微增加了攻击者的成本，并不能保证真正的安全。即使你说在前端做了RSA公钥加密，也很有可能被高手获取到公钥，并使用该公钥加密数据后发给服务端，所以务必认为前端的数据是不可靠的，服务端要加以辩别。敏感信息建议上https。

所以一般建议上https，敏感信息md5混淆，前端不传输金额字段，而是传递商品id，后端取商品id对应的金额，将金额等参数加签名发送到支付系统。金额可以是明文的。

token授权机制 ：用户使用用户名密码登录后，后台给客户端返回一个token（通常是UUID），并将Token-UserId键值对存储在redis中，以后客户端每次请求带上token，服务端获取到对应的UserId进行操作。如果Token不存在，说明请求无效。
弊端 ：token可以被抓包获取，无法预防MITM中间人攻击

用户每次请求都带上当前时间的时间戳timestamp，服务器收到请求后对比时间差，超过一定时长（如5分钟），则认为请求失效。时间戳超时机制是防御DOS攻击的有效手段。

将token，timestamp等其他参数以字典序排序，再加上一个客户端私密的唯一id（这种一般做在服务端，前端无法安全保存这个id）或使用私钥签名，将前面的字符串做MD5等加密，作为sign参数传递给服务端。

地球上最重要的加密算法：非对称加密的RSA算法。公钥加密的数据，可以用私钥解密；私钥签名（加密）的数据，可以用公钥验签。

RSA原理是对极大整数做因数分解，以下摘自维基网络。

暂时比较忙没时间，将于7月29日晚更新。
来更新啦。
微信支付安全规范，可以查看官方文档 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=4_3
第1点中，其签名算法最重要的一步，是在最后拼接了商户私密的API密钥，然后通过md5生成签名，这时即使金额是明文也是安全的，如果有人获取并修改了金额，但是签名字段他是无法伪造的，因为他无法知道商户的API密钥。当然，除了微信支付的拼接API生成签名的方法，我们也可以通过java自带的security包进行私钥签名。其中nonce随机字符串，微信支付应该做了校验，可以防止重放攻击，保证一次请求有效，如果nonce在微信支付那边已经存在，说明该请求已执行过，拒绝执行该请求。

阮一峰老师的博客-RSA算法原理： http://www.ruanyifeng.com/blog/2013/07/rsa_algorithm_part_two.html
维基网络： https://zh.wikipedia.org/wiki/RSA%E5%8A%A0%E5%AF%86%E6%BC%94%E7%AE%97%E6%B3%95

Ⅲ API接口入门（一）：读懂API接口文档

本文目录：

API接口是什么？

为什么我们需要API接口？

API接口的核心

一、API接口是什么？

我们来以一个常见的数学公式理解API，比如y=x+2，当x=2的时候，y=4，对么？

那此时，我们把y=x+2称为接口，x=2称为参数，y=4称为返回结果，那这个接口的功能就是能把我们输入的数加上2（注意：这里你可以发现接口自身是带有逻辑的）。

类比地，我们来理解一个常见的场景，比如现在有一个可以把经纬度转化为城市的接口，那当我输入经度是55°，纬度是88°的时候，接口通过自己的逻辑运算，返回结果告诉我：杭州市。

这样你就可以清晰地了解网络的官方解释了，接口就是预先定义的函数逻辑，他是供其他系统请求，然后返回结果的一个东西。

二、为什么我们需要API接口？

背景：我们的业务系统涉及多方多面，如果要一个公司或者一个系统把所有业务都做完，那未免工作量太大了吧？并且如果其他系统或公司有更好的运算逻辑，那我们在设计功能的时候可以考虑利用接口进行开发。

核心需求：利用现有接口可以降低开发成本，缩短开发成本。

举个例子：比如我是打车的APP，现在我需要在我的页面上展现地图的功能，对于我司而言，新做地图功能未免成本过高，那我们可以在高德开放平台或者网络地图的开放平台，找到地图API，这样的话我们只需要购买高德的服务，部署调用高德地图API，这样就可以快速在我们页面上线地图功能了。

三、API接口的核心

对于小白而言，初看API文档可能是一头雾水的——从哪里看，怎么看，看什么是摆在面前的问题。

其实对于产品经理而言，我们应该更关注这个公司可以提供什么样的API接口服务，比如我知道高德可以提供地图API，规划路线的API，这样的话在我们设计功能和工作中就可以想到调用他们的服务或者参考。

所以产品小白们看不懂也不用过于担心，未来工作中你也会更深入了解清楚，因为看懂并不复杂，以下是API接口的核心点，所有的说明文档离不开这5个核心点。

以下说明均以微信开放平台为例说明，文末有各开放平台的地址，大家有空可以去学习。好了，事不宜迟，现在我们来建立一个场景。

我们现在有一个APP，需要用户在购买的时候调起微信支付的API，完成购买。请各位自动进入这个场景，把自己当作一位产品经理。

1. 接口地址

现在Now，用户点击付款，我们需要告诉微信，我们要调起你们的收银台啦！但，去哪里告诉呢？这就需要接口地址了，也就相当于向微信的这条链接传输指定的数据。

一个链接地址不是我们理解的一个页面，你可以理解是一个电话号码，小凯敬白们要改变这个观念。

此时我们可以看到接口文档告诉我们链接是如下这条，那我们现在已经拨通微信的电话了。

2. 请求参数（报文逗明）

我们现在需要告诉微信，你想调用收银台对吧。那我们需要写下来，此时生成的叫做报文，也就是你想告诉这个接口的内容是什么？相当于前文函数的输入x=2。

一般来说，报文的格式和内容都是按接口文档规定的。如下文就是微信开放平台对调起收银台的报文要求。

我们先来看前2个参数，你现在跟微信在对话，是不是应该先告诉微信，你是谁？这里微信的文档告诉你应该要用应用ID+商户号来确定你的身份，什么意思呢？

比如你是A商户，下面有a，b，c三个APP，所以微信要知道你是哪个商家，下面的哪个APP要用收银台。这是非常重要的，微信后面要把收到的钱打到对应的账户以及统计数据等。

那我们就在报文里面写下这两句话：

<appid>wx2421b1c4370ec43b</appid>（我的应用ID是wx2421…….）

<mch_id>10000100</mch_id>（我的商户号是10000…….）

好了，现在微信知道你是谁了，那你山孙告要告诉微信，你需要微信支付帮你收多少钱对吧？这里定义了货币类型和总金额，也就是收什么货币，收多少钱。

这里你看，货币类型的必填写了否，也就是说你也可以不告诉微信支付货币类型是什么，因为他在后面备注了默认是人民币。

好的，那我们写下两段报文

<free_type>CNY</ free_type >（我要收人民币）

<total_fee>1</total_fee>（我要收1元）

好了，现在微信知道你是谁，也知道要收多少钱了，那接下来微信支付要把收钱结果告诉你呀，因为你得知道用户是成功支付了才能继续发货，服务啊等等的。所以这里我们用到通知地址，就是告诉微信，等下完事了他去哪里告诉你支付结果。那我们把地址写好：

<notify_url>http://wxpay.wxutil.com/pub_v2/pay/notify.v2.php</notify_url>

3. 返回结果

刚刚微信支付已经去收款了，现在他要在我们留下的通知地址中，告诉我们结果了。结果无非是两种：成功收款？收款不成功？

（1）成功

很顺利，现在用户成功付钱了，并且微信也把成功的消息告诉我们了，并且他还把用户支付的一些信息也告诉我们。

那这里就是微信支付成功收款后告诉我们的信息。

应用APPID，商户号：告诉你我成功扣款的是哪家商户的哪个APPID的交易。

业务结果：成功或失败

（2）失败

在产品设计的时候，我们往往很关注失败的情况，当收款失败的时候，微信同时会告诉你失败的原因，如下图很好理解，失败的原因有很多很多种，我们在设计的时候往往要分析每种失败的原因，为每个失败的原因设计页面和用户提示，以确保用户能理解。

以上就是API接口基本运作模式的理解，下面我将继续更新API接口的一些更为深入和细节的关键元素，如请求方式/签名/加解密等等。

可供参考的开放平台网站

微信支付：https://pay.weixin.qq.com/wiki/doc/api/index.html

高德平台开放平台：https://lbs.amap.com/

Ⅳ 什么是API接口，PHP开发API接口的例子

就是php只处理数据，而不直接输出html

把视图层都交给js去完成。

比如：

//获取数据
$id=$_GET['id'];
if($id){
	//支数据库取数据
	$sql="select*fromtablewhereid='".$id."'";
$re=.....;
	echojson_encode($re);//返回json格式数据给前端处理
}

//修改数据
if($id&&$_GET['edit']){
	////数据库操作
	echo"修改成功";
}

Ⅳ php如何开发API接口

比如一个自定义函数：function test(){echo ‘hello world’;}就可以叫做 api。api 既可以是单个的函数，也可以是封装在类里的方法，当然它们也是程序代码。开发一个 api 的流程可以很简单，也可以很复杂，视具体的编程任务而决定，并没有特定的规则。比如，你需要为自己建立一个常用的函数库，命名为 my.lib.php然后把你自己编写的自定义函数，全部写在这个文件里面，那么，你就拥有了自己的api。开发的时候，只需要引入 my.lib.php，你就可以调用自己的 api 了。这是一个比较简单的例子。稍微复杂一点的，你可以把函数封装在类里面，方便继承和重用，还可以根据函数名称做一些程序设计，这个一句话说不清楚，给一个简单的例子吧：class mylib{function showmy(){echo ‘这是我的一个类方法’;}}调用的时候，先要实例化类，然后再调用方法。再复杂一点的就是使用类接口，区别就是接口里面定义的只是方法原型，而你需要通过具体的类来实现接口中的函数，具体请参考 php 手册

Ⅵ 简单获取新浪短网址API接口的方法（附PHP请求示例）

新浪短网址api是新浪官方对外公开的短网址生成接口，可以将冗长的链接地址缩短生成 t.cn 格式的短链接，下面分享一个获取新浪短网址API接口的方法以及接口请求方法。

1、在线使用

将API地址中 "http://www..com"   的部分换成自己的长网址，然后复制前往浏览器中粘贴打开就能生成了。

2、请求接口

如果嫌在线生成的流程很麻烦，可以将API接口对接到程序中请求生成，请求示例如下。

PHP请求示例：

Java请求示例：

Python请求示例：

1、调用API接口时，只需将 “http://www..com”换成需要缩短的长链接即可。

2、接口支持链接中带参数，但要注意的是当链接中出现 & 符号时，请用 %26 代替（或者使用url编码），否则参数可能会丢失。

3、更换链接时，必须要以http(s)://开头，否则可能会导致短网址生成失败或者生成的短网址无法跳转访问原网站。

4、上文提到的新浪短网址API接口，经测试都是比较稳定的，觉得好用记得收藏一下，以免丢失。

1、长链接转换后，为什么结尾的参数丢失了？

答：因为长链接中含有特殊字符，需要将url编码后再使用接口生成。

2、接口没有返回结果，是什么情况？

答：有些时候接口返回数据会有延迟，超时未返回即生成失败，也就不会返回结果；或者是因为原链接被封了。

3、生成的短链接有效期是多久？有没有访问次数限制？

答：生成的t.cn短链接是永久有效的，没有点击次数限制，可以放心使用。

Ⅶ 如何使用MixPHP来开发API接口

下面做一个开发 API 接口的简单实例：

从articles表，通过id获取一篇文章。

访问该接口的 URL：

1

http://www.e.com/articles/details?id=1

数据库表结构如下：

1

2

3

4

5

6

7

CREATE TABLE `articles` (

`id` int(10) unsigned NOT NULL AUTO_INCREMENT,

`title` varchar(255) NOT NULL,

`content` varchar(255) NOT NULL,

`dateline` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,

PRIMARY KEY (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8;

第一步

修改数据库配置文件，MixPHP 的应用配置文件中，关于数据库的信息都引用了 common/config/database.php 文件。

框架默认的 404/500 响应是网页，而 API 服务需要响应 JSON 数据，通常其他传统 MVC 框架需要修改很多地方才可完成这个需求，MixPHP 本身就提供该种配置，只需修改一下配置即可。

MixPHP 的默认 Web 应用中有两个配置文件，分别为：

开发 API 时我们推荐在 Apache/PHP-FPM 下开发，上线再部署至 mix-httpd 即可，反正是无缝切换的。

现在我们修改 response 键名下的 defaultFormat 键为 mixhttpError::FORMAT_JSON，如下：

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

// 响应

'response' => [

// 类路径

'class' => 'mixhttpcompatibleResponse',

// 默认输出格式

'defaultFormat' => mixhttpResponse::FORMAT_JSON,

// json

'json' => [

// 类路径

'class' => 'mixhttpJson',

],

// jsonp

'jsonp' => [

// 类路径

'class' => 'mixhttpJsonp',

// callback键名

'name' => 'callback',

],

// xml

'xml' => [

// 类路径

'class' => 'mixhttpXml',

],

],

然后修改 main_compatible.php 文件中 error 键名下的 format 键为 mixhttpError::FORMAT_JSON，如下：

1

2

3

4

5

6

7

// 错误

'error' => [

// 类路径

'class' => 'mixhttpError',

// 输出格式

'format' => mixhttpError::FORMAT_JSON,

],

第三步

创建控制器：

1

apps/index/controllers/ArticlesController.php

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

<?php

namespace appsindexcontrollers;

use mixfacadesRequest;

use mixhttpController;

use appsindexmessagesErrorCode;

use appsindexmodelsArticlesForm;

class ArticlesController extends Controller

{

public function actionDetails()

{

// 使用模型

$model = new ArticlesForm();

$model->attributes = Request::get();

$model->setScenario('actionDetails');

if (!$model->validate()) {

return ['code' => ErrorCode::INVALID_PARAM];

}

// 获取数据

$data = $model->getDetails();

if (!$data) {

return ['code' => ErrorCode::ERROR_ID_UNFOUND];

}

// 响应

return ['code' => ErrorCode::SUCCESS, 'data' => $data];

}

}

创建错误码类：

1

apps/index/messages/ErrorCode.php

1

2

3

4

5

6

7

8

9

10

11

12

<?php

namespace appsindexmessages;

class ErrorCode

{

const SUCCESS = 0;

const INVALID_PARAM = 100001;

const ERROR_ID_UNFOUND = 200001;

}

创建表单验证模型：

1

apps/index/models/ArticlesForm.php

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

<?php

namespace appsindexmodels;

use mixvalidatorsValidator;

use appscommonmodelsArticlesModel;

class ArticlesForm extends Validator

{

public $id;

// 规则

public function rules()

{

return [

'id' => ['integer', 'unsigned' => true, 'maxLength' => 10],

];

}

// 场景

public function scenarios()

{

return [

'actionDetails' => ['required' => ['id']],

];

}

// 获取详情

public function getDetails()

{

return (new ArticlesModel())->getRowById($this->id);

}

}

创建数据表模型：

1

apps/common/models/ArticlesModel.php

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

<?php

namespace appscommonmodels;

use mixfacadesRDB;

class ArticlesModel

{

const TABLE = 'articles';

// 获取一行数据通过id

public function getRowById($id)

{

$sql = "SELECT * FROM `" . self::TABLE . "` WHERE id = :id";

$row = RDB::createCommand($sql)->bindParams([

'id' => $id,

])->queryOne();

return $row;

}

}

以上就是全部代码的编写。

Ⅷ php哪个框架适合做api

在所有轻量级框架中，我推荐 CodeIgniter。 美中不足就是，框架入门极其简单。但是，如果实现 完全的、优雅的 restful，门槛就有点儿高了。CodeIgniter 实现 restful 时，和底层的 HTTP 协议有些脱节，这些可以通过扩展框架来实现，而且有时候需要结合服务器去配置。

Ⅸ 如何用PHP开发API接口

他会提供相应接口给你的，具体调用方法就相当于讲求某个链接。act=get_user_list&type=json在这里operate.php相当于一个接口，其中get_user_list 是一个API（获取用户列表），讲求返回的数据类型为JSON格式。

act=get_user_list&type=json';$ch=curl_init();curl_setopt($ch,CURLOPT_URL,$url);curl_setopt($ch,CURLOPT_RETURNTRANSFER,1);curl_setopt($ch,CURLOPT_CONNECTTIMEOUT,10);curl_setopt($ch,CURLOPT_POST,1);//启用POST提交$file_contents=curl_exec($ch);curl_close($ch);