spatie/dropbox-api

A minimal implementation of Dropbox API v2

A minimal implementation of Dropbox API v2

, _(*1)

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., _(*2)

Here are a few examples on how you can use the package:, _(*3)

$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);

Support us

, _(*4)

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products., _(*5)

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall., _(*6)

Installation

You can install the package via composer:, _(*7)

``` bash composer require spatie/dropbox-api, <sub>(*8)</sub>

## Usage

The first thing you need to do is get an authorization token at Dropbox. Unlike [other companies](https://google.com) Dropbox has made this very easy. You can just generate a token in the [App Console](https://www.dropbox.com/developers/apps) for any Dropbox API app. You'll find more info at [the Dropbox Developer Blog](https://blogs.dropbox.com/developers/2014/05/generate-an-access-token-for-your-own-account/).

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

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

or alternatively you can implement Spatie\Dropbox\TokenProvider which will provide the access-token from its TokenProvider->getToken(): string method., <sub>(*9)</sub>

If you use oauth2 to authenticate and to acquire refresh-tokens and access-tokens, (like thephpleague/oauth2-client), you can create an adapter that internally takes care of token-expiration and refreshing tokens, and at runtime will supply the access-token via the TokenProvider->getToken(): string method., <sub>(*10)</sub>

(Dropbox announced they will be moving to short-lived access_tokens mid 2021)., <sub>(*11)</sub>

// implements Spatie\Dropbox\TokenProvider
$tokenProvider = new AutoRefreshingDropBoxTokenService($refreshToken);
$client = new Spatie\Dropbox\Client($tokenProvider);

or alternatively you can authenticate as an App using your App Key & Secret., <sub>(*12)</sub>

$client = new Spatie\Dropbox\Client([$appKey, $appSecret]);

If you only need to access the public endpoints you can instantiate Spatie\Dropbox\Client without any arguments., <sub>(*13)</sub>

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

Dropbox Endpoints

Look in the source code of Spatie\Dropbox\Client to discover the methods you can use., <sub>(*14)</sub>

Here's an example:, <sub>(*15)</sub>

$content = 'hello, world';
$client->upload('/dropboxpath/filename.txt', $content, $mode='add');

$from = '/dropboxpath/somefile.txt';
$to = '/dropboxpath/archive/somefile.txt';
$client->move($from, $to);

If the destination filename already exists, dropbox will throw an Exception with 'to/conflict/file/..', <sub>(*16)</sub>

The upload() and move() methods have an optional extra 'autorename' argument to try and let dropbox automatically rename the file if there is such a conflict., <sub>(*17)</sub>

Here's an example:, <sub>(*18)</sub>

$from = '/dropboxpath/somefile.txt';
$to = '/dropboxpath/archive/somefile.txt';
$client->move($from, $to, $autorename=true);
// with autorename results in 'somefile (1).txt'

If you do not find your favorite method, you can directly use the contentEndpointRequest and rpcEndpointRequest functions., <sub>(*19)</sub>

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

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

Here's an example:, <sub>(*20)</sub>

$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::., <sub>(*21)</sub>

Here's an example:, <sub>(*22)</sub>

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

Changelog

Please see CHANGELOG for more information what has changed recently., <sub>(*23)</sub>

Testing

bash composer test, <sub>(*24)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*25)</sub>

You can run composer pint to run the code style fixer, and composer phpstan to run the static analysis., <sub>(*26)</sub>

Security

If you've found a bug regarding security please mail security@spatie.be instead of using the issue tracker., <sub>(*27)</sub>

Postcardware

You're free to use this package (it's MIT-licensed), but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using., <sub>(*28)</sub>

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium., <sub>(*29)</sub>

We publish all received postcards on our company website., <sub>(*30)</sub>

Credits

• Alex Vanderbist
• Freek Van der Herten
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*31)</sub>