imbin / instagram-php
一个易于使用的PHP类,用于访问Instagram的API。
Requires
- php: >=5.3.0
- ext-curl: *
This package is auto-updated.
Last update: 2024-09-29 06:03:01 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 cosenary/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(<数组>/<字符串>);
如果您想认证用户并访问其数据,请使用array
new Instagram(array( 'apiKey' => 'YOUR_APP_KEY', 'apiSecret' => 'YOUR_APP_SECRET', 'apiCallback' => 'YOUR_APP_CALLBACK' ));
如果您只想访问公共数据,请使用string
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>)
- 如果未定义
$id
或等于'self'
,它将返回登录用户的媒体
- 如果未定义
关系方法
认证方法
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许可证 下发布。