README

Simple abstraction wrapper around Alldebrid API v4 in PHP.

Requires PHP 7.1 or newer.

Documentation

The documentation for the Alldebrid API can be found here.

The PHP library documentation can be found in this README. An example folder is also provided to show library usage.

Installation

You can install alldebrid-php in two ways, by using composer or downloading and including the standalone file.

Via Composer:

alldebrid-php is available on Packagist as the alldebrid/alldebrid-php package:

composer require alldebrid/alldebrid

Then add the autoloader to your application with this line: require("vendor/autoload.php")

Via include:

A standalone version of this library is provided, just download and include it manually :

include './alldebrid.standalone.php';

Quickstart

Authentication

The Alldebrid API requires an agent and an apikey to authenticate requests. The agent is your app / library name (doc).

You can view , create and manage your API keys in your Alldebrid Apikey dashboard, or generate them remotly (with user action) through the PIN flow (doc / example).

$agent = 'myAppName'; // Your project name
$apikey = 'YYYYYY'; // Apikey

$alldebrid = new \Alldebrid\Alldebrid($agent, $apikey);

Use and error handling

This library use Go-style error handling by default, but can be configured to use Exception if you choose so.

$agent = 'myAppName'; // Your project name
$apikey = 'YYYYYY'; // Apikey

$alldebrid = new \Alldebrid\Alldebrid($agent, $apikey);

// Go-style, always return an array [ $response, $error ]
[ $user, $error ] = $alldebrid->user();

if($error) {
    // Api call failed or returned an error
    $errorMessage = $user;
    die("Could not get user informations, error " . $error . " : " . $errorMessage . "\n");
}

// No error, you can consume the response 
echo "Hello, " . $user['username'] . "\n";

Using the library with Exceptions

$agent = 'myAppName'; // Your project name
$apikey = 'YYYYYY'; // Apikey

$alldebrid = new \Alldebrid\Alldebrid($agent, $apikey);
$alldebrid->setErrorMode('exception');

try {
    $user = $alldebrid->user();
} catch(Exception $e) {
    die("Exception " . $e->getMessage() . "\n");
}

// No error, you can consume the response 
echo "Hello, " . $user['username'] . "\n";

High-level and low-level use

This library provides multiple ways to use the Alldebrid API, once the agent and apikey are set.

The lowest-level use is to call the api() function with the desired endpoint and parameters :

$alldebrid = new \Alldebrid\Alldebrid($agent, $apikey);
$myLink = 'https://example.com/example';
[ $response, $error ] = $alldebrid->api('link/infos', ['link' => [ $myLink ] ]);

Every API endpoint has its own wrapper function you can use, which handles proper parameters naming and some response checking :

$alldebrid = new \Alldebrid\Alldebrid($agent, $apikey);
$myLink = 'https://example.com/example';
[ $response, $error ] = $alldebrid->linkInfos($myLink);

Finally, for links, magnets and pin auth, helper objects are provided to easily interact with them :

$alldebrid = new \Alldebrid\Alldebrid($agent, $apikey);
$myLink = 'https://example.com/example';

$link = $alldebrid->link($myLink);
[ $response, $error ] = $link->infos();
//  you can then call $link->unlock() if there is no error

Every calls of this library are documented in the example folder.

Configuration

Some options can tweak how this library behaves. The wrapper has a public options array property that you can update.

$alldebrid = new \Alldebrid\Alldebrid($agent, $apikey);

// By default retry=true and maxRetries=2, the library will retry failed request 2 times
$alldebrid->options['retry'] = false; // Disable retry
$alldebrid->options['maxRetries'] = 5; // Raise max retries 

// By default autoInit=false, the library wont make any api call you didn't request explicitly
$alldebrid->options['autoInit'] = true; // Get user and hosts informations on wrapper creation

// By default autoUnlockBestStreamQuality=false
$alldebrid->options['autoUnlockBestStreamQuality'] = true; // On link with multiple stream options, the library will automatically unlock the highest quality source

// By default ignoreRedirector=true
$alldebrid->options['ignoreRedirector'] = true; // Flag to make the library handle redirectors

// By default exceptions=false
$alldebrid->options['exceptions'] = true; // Use Exception for error handling. Can also use $alldebrid->setErrorMode('exception');

Getting help

If you need help installing or using the library, please check the Api docs first, check the example codes and then contact us if you don't find an answer to your question.

If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!

alldebrid / alldebrid-php

Maintainers

Details