overherz/instagram

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

v2.4.1 2017-02-28 10:13 UTC

This package is auto-updated.

Last update: 2024-09-12 19:32:39 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主要指的是“客户端”而不是“应用”。因此,“客户端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.14544189229033611.568603515625
    • $distance:径向距离(单位:米,默认为1公里=1000,最大为5公里=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)标记,这允许您识别视频。

如何使用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许可证下发布。