Foursquare PHP 库技术文档

1. 安装指南

使用 Composer 安装

推荐使用 Composer 来安装 Foursquare PHP 库。在终端中运行以下命令：

composer require hownowstephen/php-foursquare:'1.2.*'

如果你没有使用自动加载器，你需要手动引入自动加载文件：

require_once 'vendor/autoload.php';

手动安装

你也可以直接从 GitHub 仓库下载最新版本的库文件。

2. 项目使用说明

查询 API

Foursquare PHP 库封装了 Foursquare API 的公共和私有资源请求功能。你可以通过路径直接调用 API 端点，例如：

$foursquare = new FoursquareApi("<your client key>", "<your client secret>");

// 搜索附近的地点，例如蒙特利尔
$endpoint = "venues/search";
$params = array("near"=>"Montreal, Quebec");

// 执行公共资源请求
$response = $foursquare->GetPublic($endpoint, $params);

// 返回 Venue 列表
$venues = $foursquare->GetPublic($endpoint, $params, $POST=false);

用户认证

为了访问私有资源，你需要为用户获取认证令牌。以下是一个简单的认证流程：

$foursquare = new FoursquareApi("<your client key>", "<your client secret>");

// 设置重定向 URL
$redirect_url = "http://localhost/foursquare_code_handler";

// 生成认证链接
$auth_link = $foursquare->AuthenticationLink($redirect_url);

// 将认证代码转换为访问令牌
$code = $_GET['code'];
$token = $foursquare->GetToken($code, $redirect_url);

// 设置访问令牌
$foursquare->SetAccessToken($token);

// 请求私有资源
$endpoint_private = "users/self";
$me = $foursquare->GetPrivate($endpoint_private);

3. 项目 API 使用文档

公共资源请求

$foursquare->GetPublic($endpoint, $params, $POST=false);

• $endpoint: API 端点路径。
• $params: 请求参数数组。
• $POST: 是否使用 POST 请求，默认为 false。

私有资源请求

$foursquare->GetPrivate($endpoint);

• $endpoint: API 端点路径。

设置访问令牌

$foursquare->SetAccessToken($token);

• $token: 用户的访问令牌。

生成认证链接

$foursquare->AuthenticationLink($redirect_url);

• $redirect_url: 认证成功后的重定向 URL。

获取访问令牌

$foursquare->GetToken($code, $redirect_url);

• $code: 从 Foursquare 获取的认证代码。
• $redirect_url: 重定向 URL。

4. 项目安装方式

使用 Composer 安装

composer require hownowstephen/php-foursquare:'1.2.*'

手动安装

直接从 GitHub 仓库下载最新版本的库文件。