gisocial/instagram

一个易于使用的PHP类,用于访问Instagram的API。

v2.3 2014-11-29 13:10 UTC

This package is not auto-updated.

Last update: 2024-09-28 19:58:04 UTC


README

注意: 2015年11月17日,Instagram 更新了其API。<2015年11月17日之前创建的应用程序将不受影响,直到2016年6月。2015年11月17日或之后创建的应用程序需要使用其更新的API。请注意,此库尚未支持其新更新。有关更多信息,请参阅#182

Instagram API的PHP包装器。欢迎反馈或错误报告。

Total Downloads Latest Stable Version License

有可用的Composer包。
支持Instagram视频签名头

需求

  • PHP 5.3或更高版本
  • cURL
  • 已注册Instagram应用

开始使用

要使用Instagram API,您必须在Instagram开发者平台注册为开发者并创建一个应用程序。注册重定向URI之前,请查看uri指南。您将收到您的client_idclient_secret

请注意,Instagram主要指的是“客户端”而不是“应用”。因此,“Client ID”和“Client Secret”与“App Key”和“App Secret”相同。

开始的好地方是示例项目

安装

强烈建议使用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.14544189229033611.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 属性(imagevideo),这允许你识别视频。

如何在 /example 文件夹中通过使用 Video.js 嵌入 Instagram 视频的示例,可以在 /example 文件夹中找到。

请注意: Instagram 目前不允许筛选视频。

签名头

为了防止你的访问令牌被盗,Instagram 建议使用你的 API 秘密的哈希值、调用的端点和参数来对你的请求进行签名。

  1. 在你的 Instagram 客户端设置中激活 "强制签名头"
  2. 在 Instagram 类中启用签名头
$instagram->setSignedHeader(true);
  1. 你已经准备好出发了!现在,所有你的请求都将通过签名头进行安全保护。

Instagram API 文档 中详细了解它是如何工作的。

分页

每个端点都有一个最大结果范围,因此提高 limit 参数超过限制是没有帮助的(例如,getUserMedia() 的限制为 90)。

这就是“分页”功能发挥作用的地方。只需将一个对象传递给 pagination() 方法,即可接收下一个数据集

$photos = $instagram->getTagMedia('kitten');

$result = $instagram->pagination($photos);

使用 do-while 循环进行迭代。

重定向 URL 的示例

如果你需要有关端点的更多信息,请查看 Instagram API 文档

示例应用

Image

此示例项目位于example/文件夹中,可以帮助您开始使用。代码具有良好的文档,并指导您完成OAuth2流程的所有必要步骤。感谢Ricardo de Zoete Pro提供的出色Instagram图标。

更多示例和教程

如果您也要分享代码示例,请告诉我。

变更日志

有关更多信息,请参阅变更日志文件

鸣谢

版权(c)2011-2015 - 由Christian Metz编写

BSD许可下发布。