softonic/download_api_sdk

This package is abandoned and no longer maintained. No replacement package was suggested.

2.6.0 2020-12-15 17:33 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• Swagger and contributors

• php
• api
• sdk
• swagger

README

Generated URLs with TTL for downloading binary files

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 2.44.0
• Package version: 2.3.0
• Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit http://corporate.softonic.com/contact-us

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/softonic/download_api_sdk.git"
    }
  ],
  "require": {
    "softonic/download_api_sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/DownloadApiSdk/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: download_api_access_code
$config = Softonic\DownloadApiSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: download_api_application
$config = Softonic\DownloadApiSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: download_api_implicit
$config = Softonic\DownloadApiSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: download_api_password
$config = Softonic\DownloadApiSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Softonic\DownloadApiSdk\Api\FilesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id_files = "id_files_example"; // string | SHA-1 hash that identifies a file
$country = "country_example"; // string | The country from where the request is being done, used to sort download URL list
$extra = "extra_example"; // string | Associative array of parameters serialized and encoded in base64

try {
    $result = $apiInstance->readFile($id_files, $country, $extra);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilesApi->readFile: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://download-v2.eu-west.sftapi.com

Class	Method	HTTP request	Description
FilesApi	readFile	GET /files/{id_files}	Fetches a single File
FilesUrlsApi	findFileUrl	GET /files/{id_files}/urls	List of FileUrls

Documentation For Models

• File
• FileUrl

Documentation For Authorization

download_api_access_code

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://oauth-v2.softonic.com/token
• Scopes:
• download_api.read.files: Read Files
• download_api.find.files.urls: Find Files/Urls

download_api_application

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• download_api.read.files: Read Files
• download_api.find.files.urls: Find Files/Urls

download_api_implicit

• Type: OAuth
• Flow: implicit
• Authorization URL: https://oauth-v2.softonic.com/authorize
• Scopes:
• download_api.read.files: Read Files
• download_api.find.files.urls: Find Files/Urls

download_api_password

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes:
• download_api.read.files: Read Files
• download_api.find.files.urls: Find Files/Urls

Author

[e-mail]