agyson/dropbox-api

A Custom made & minimal implementation of Dropbox API v2

dev-master 2020-02-08 16:46 UTC

Requires

• php: ^7.1
• graham-campbell/guzzle-factory: ^3.0
• guzzlehttp/guzzle: ^6.2
• spatie/flysystem-dropbox: ^1.2.2

Requires (Dev)

• phpunit/phpunit: ^7.5.15|^8.5

Replaces

• spatie/dropbox-api: *

MIT

• Alex Vanderbist
• Freek Van der Herten

• api
• dropbox
• v2
• Dropbox-API
• spatie

README

This is a minimal PHP implementation of the Dropbox API v2. It contains only the methods needed for our flysystem-dropbox adapter. We are open however to PRs that add extra methods to the client.

Here are a few examples on how you can use the package:

$client = new Spatie\Dropbox\Client($authorizationToken);

//create a folder
$client->createFolder($path);

//list a folder
$client->listFolder($path);

//get a temporary link
$client->getTemporaryLink($path);

Installation

You can install the package via composer:

composer require agyson/dropbox-api

Usage

SAME AS Spatie\Dropbox.

The first thing you need to do is get an authorization token at Dropbox. Unlike other companies Dropbox has made this very easy. You can just generate a token in the App Console for any Dropbox API app. You'll find more info at the Dropbox Developer Blog.

With an authorization token you can instantiate a Spatie\Dropbox\Client.

$client = new Spatie\Dropbox\Client($authorizationToken);

Look in the source code of Spatie\Dropbox\Client to discover the methods you can use.

If you do not find your favorite method, you can directly use the contentEndpointRequest and rpcEndpointRequest functions.

public function contentEndpointRequest(string $endpoint, array $arguments, $body): ResponseInterface

public function rpcEndpointRequest(string $endpoint, array $parameters): array

Here's an example:

$client->rpcEndpointRequest('search', ['path' => '', 'query' => 'bat cave']);

If you need to change the subdomain of the endpoint URL used in the API request, you can prefix the endpoint path with subdomain::.

Here's an example:

$client->rpcEndpointRequest('content::files/get_thumbnail_batch', $parameters);

License

The MIT License (MIT). Please see License File for more information.