lara4477 / dropbox
Dropbox SDK for PHP
Requires
- php: >= 5.3
- ext-curl: *
Requires (Dev)
- apigen/apigen: 4.1.2
- phpunit/phpunit: ~4.0
- squizlabs/php_codesniffer: 2.0.0RC3
This package is auto-updated.
Last update: 2024-09-29 05:55:33 UTC
README
一个用于访问 基于HTTP的Dropbox API 的PHP库。
许可证: MIT
要求
- PHP 5.3+,需要64位整数。
- PHP cURL扩展(通常内置)并启用SSL。
- 不能使用
mbstring.func_overload
来覆盖PHP的标准字符串函数。
配置
如果你使用 Composer 来管理项目依赖项,请将以下内容添加到你的 "composer.json" 文件中:
"require": {
"dropbox/dropbox-sdk": "1.1.*"
}
如果你没有使用Composer,请下载代码,将 "lib/" 文件夹复制到你的项目中的某个位置,并在你的代码中包含 "lib/Dropbox/autoload.php"。例如,如果你将 "lib/" 复制并命名为 "dropbox-sdk/",则你会这样做:
// Do this only if you're not using a global autoloader (such as Composer's). require_once "dropbox-sdk/Dropbox/autoload.php";
重要:许多PHP安装都有一个不安全的SSL实现。要检查你的PHP安装是否不安全,请运行包含的 "examples/test-ssl.php" 脚本,无论是通过命令行还是通过你的web服务器。
获取Dropbox API密钥
你需要一个Dropbox API密钥来发送API请求。
- 访问:https://dropbox.com/developers/apps
- 如果你已经注册了一个应用,请点击“选项”链接查看应用的API密钥和秘密。
- 否则,请点击“创建应用”来注册一个应用。选择“Dropbox API应用”,然后选择“文件和数据存储”,然后根据你的需要选择“是”或“否”。
将API密钥保存到一个名为“test.app”的JSON文件中。
{
"key": "Your Dropbox API app key",
"secret": "Your Dropbox API app secret"
}
使用Dropbox API
在您的应用可以访问Dropbox用户的文件之前,用户必须使用OAuth 2授权您的应用程序。成功完成此授权流程后,您将获得一个用于用户Dropbox账户的 访问令牌,这允许您通过Dropbox API调用访问其文件。
- 简单Web应用的授权示例: Web文件浏览器示例
- 命令行工具的授权示例: 命令行授权示例
一旦你有了访问令牌,创建一个 Client
并开始发送API请求。
您只需要为每个用户执行一次授权过程。一旦您为用户获取了访问令牌,请将其保存在持久的位置,例如数据库中。下次该用户访问您的应用时,您可以跳过授权过程并直接进行API调用。
运行示例和测试
- 下载此存储库。
- 将您的Dropbox API密钥保存到一个名为“test.app”的文件中。请参阅:获取Dropbox API密钥,如上所述。
authorize.php
此示例执行OAuth 2授权流程。
./examples/authorize.php test.app test.auth
这将生成一个名为“test.auth”的文件,其中包含访问令牌。此文件可以传递给其他示例。
account-info.php
一个简单的示例,它调用/account/info API端点。
./examples/account-info.php test.auth
(您必须首先使用上面的“authorize”示例生成“test.auth”文件。)
web-file-browser.php
一个通过OAuth 2授权流程运行的小型Web应用,然后使用Dropbox API调用让用户浏览他们的Dropbox文件。
必需:将您之前创建的其中一个".app"文件复制到"examples/web-file-browser.app"。
使用PHP内置的Web服务器(PHP 5.4+)。
- 访问Dropbox API的应用控制台,转到"web-file-browser.app"中配置的API应用,转到OAuth重定向URI部分,并添加"https://:5000/dropbox-auth-finish"。
- 运行"
php web-file-browser.php
"。 - 将您的浏览器指向"https://:5000/"。
使用现有的Web服务器设置。
- 将整个SDK文件夹复制到您的Web服务器的文档路径中。例如,假设脚本可通过"https:///~scooby/dropbox/examples/web-file-browser.php"访问。
- 访问Dropbox API的应用控制台,转到"web-file-browser.app"中配置的API应用,转到OAuth重定向URI部分,并添加"https:///~scooby/dropbox/examples/web-file-browser.php/dropbox-auth-finish"。
- 将您的浏览器指向"https:///~scooby/dropbox/examples/web-file-browser.php"。
运行测试
- 运行:
composer install --dev
下载依赖项。(您需要Composer。) - 在"test/test.auth"中放置一个"auth info"文件。(您可以使用"authorize.php"示例脚本来生成"test/test.auth"。)
./vendor/bin/phpunit test/