tuxxx128 / instagram
一个易于使用的PHP类,用于访问Instagram的API。
Requires
- php: >=5.2.0
- ext-curl: *
This package is not auto-updated.
Last update: 2024-09-23 13:21:31 UTC
README
注意:2015年11月17日,Instagram 对其API进行了更改。更改 将影响到2015年11月17日之前创建的应用,直到2016年6月。2015年11月17日或之后创建的应用需要使用其更新的API。请注意,这个库还不支持他们的新更新。更多信息,请参阅#182。
Instagram API的PHP包装器。欢迎反馈或错误报告。
有可用的 Composer 包。
支持 Instagram视频 和 签名头部。
要求
- PHP 5.3或更高版本
- cURL
- 已注册的Instagram应用
开始使用
要使用Instagram API,您需要在 Instagram开发者平台 注册为开发者并创建一个应用。在注册重定向URI之前,请查看 URI指南。您将收到您的 client_id
和 client_secret
。
请注意,Instagram主要指的是”客户端“而不是”应用“。因此,”客户端ID“和”客户端密钥“与”应用密钥“和”应用密钥“相同。
开始的好地方是 示例项目。
安装
强烈建议使用 Composer 以保持更新尽可能平滑。
$ composer require tuxxx128/instagram
初始化类
use MetzWeb\Instagram\Instagram; $instagram = new Instagram(array( 'apiKey' => 'YOUR_APP_KEY', 'apiSecret' => 'YOUR_APP_SECRET', 'apiCallback' => 'YOUR_APP_CALLBACK' )); echo "<a href='{$instagram->getLoginUrl()}'>Login with Instagram</a>";
用户认证(OAuth2)
// grab OAuth callback code $code = $_GET['code']; $data = $instagram->getOAuthToken($code); echo 'Your username is: ' . $data->user->username;
获取用户点赞
// set user access token $instagram->setAccessToken($data); // get all user likes $likes = $instagram->getUserLikes(); // take a look at the API response echo '<pre>'; print_r($likes); echo '<pre>';
所有方法都返回API数据 json_decode()
- 因此您可以直接访问数据。
可用方法
设置Instagram
new Instagram(<数组>/<字符串>);
数组
如果您想认证用户并访问其数据
new Instagram(array( 'apiKey' => 'YOUR_APP_KEY', 'apiSecret' => 'YOUR_APP_SECRET', 'apiCallback' => 'YOUR_APP_CALLBACK' ));
字符串
如果您 仅 想访问公开数据
new Instagram('YOUR_APP_KEY');
获取登录URL
getLoginUrl(<数组>)
getLoginUrl(array( 'basic', 'likes' ));
可选的作用域参数
获取OAuth令牌
getOAuthToken($code, <true>/<false>)
true
: 返回仅OAuth令牌
false
[默认] : 返回OAuth令牌和认证用户的配置文件数据
设置/获取访问令牌
- 设置访问令牌,用于后续的方法调用:
setAccessToken($token)
- 获取访问令牌,如果您想将其存储以供以后使用:
getAccessToken()
用户方法
公共方法
getUser($id)
searchUser($name, <$limit>)
getUserMedia($id, <$limit>)
认证方法
getUser()
getUserLikes(<$limit>)
getUserFeed(<$limit>)
getUserMedia(<$id>, <$limit>)
- 如果未定义或等于
'self'
的$id
,则返回登录用户的媒体
- 如果未定义或等于
关系方法
认证方法
getUserFollows($id, <$limit>)
getUserFollower($id, <$limit>)
getUserRelationship($id)
modifyRelationship($action, $user)
$action
: 动作命令(关注 / 取消关注 / 封禁 / 解封 / 通过 / 拒绝)$user
: 目标用户 ID
// Follow the user with the ID 1574083 $instagram->modifyRelationship('follow', 1574083);
请注意,modifyRelationship()
方法需要 relationships
权限。
媒体方法
公共方法
getMedia($id)
- 认证用户收到关于查询的媒体是否喜欢的信息
getPopularMedia()
searchMedia($lat, $lng, <$distance>, <$minTimestamp>, <$maxTimestamp>)
$lat
和$lng
是坐标,必须是类似:48.145441892290336
,11.568603515625
的浮点数$distance
: 以米为单位的半径距离(默认为 1km = 1000,最大为 5km = 5000)$minTimestamp
: 所返回的所有媒体都将晚于这个时间戳(默认:5 天前)$maxTimestamp
: 所返回的所有媒体都将早于这个时间戳(默认:现在)
评论方法
公共方法
getMediaComments($id)
认证方法
addMediaComment($id, $text)
- 受限访问:请发送邮件至
apidevelopers[at]instagram.com
以获取访问权限
- 受限访问:请发送邮件至
deleteMediaComment($id, $commentID)
- 评论必须由认证用户创建
请注意,认证方法需要 comments
权限。
标签方法
公共方法
getTag($name)
getTagMedia($name)
searchTags($name)
点赞方法
认证方法
getMediaLikes($id)
likeMedia($id)
deleteLikedMedia($id)
所有 <...>
参数都是可选的。如果限制未定义,则返回所有可用结果。
Instagram 视频
Instagram 条目带有 type
属性(image
或 video
),这允许您识别视频。
如何使用 Video.js 嵌入 Instagram 视频,示例可以在 /example
文件夹中找到。
请注意:Instagram 目前不允许筛选视频。
签名头部
为了防止您的访问令牌被盗,Instagram 建议使用 API 秘密的哈希值、调用的端点和参数来签名您的请求。
- 在您的 Instagram 客户端设置中激活 "强制签名头部"。
- 在您的 Instagram 类中启用签名头部
$instagram->setSignedHeader(true);
- 您已经准备就绪!现在,您的所有请求都将通过签名头部进行安全保护。
在 Instagram API 文档 中详细了解其工作原理。
分页
每个端点都有一个最大结果范围,因此提高 limit
参数超过限制不会有所帮助(例如,getUserMedia()
的限制为 90)。
这就是“分页”功能介入的地方。只需将一个对象传递给 pagination()
方法,即可接收下一个数据集
$photos = $instagram->getTagMedia('kitten'); $result = $instagram->pagination($photos);
使用 do-while
循环进行迭代。
重定向 URL 示例
如果您需要有关端点的更多信息,请参阅 Instagram API 文档。
示例应用程序
此示例项目位于 example/
文件夹中,可以帮助您入门。代码具有良好的文档记录,并带您完成 OAuth2 流程的所有必需步骤。感谢 Ricardo de Zoete Pro 提供出色的 Instagram 图标。
更多示例和教程
如果您也需要分享代码示例,请告诉我。
变更日志
请参阅变更日志文件以获取更多信息。
致谢
版权(c)2011-2015 - 由Christian Metz编写
在BSD许可下发布。