Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

Latest commit

 

History

History
164 lines (121 loc) · 5.49 KB

README.md

File metadata and controls

164 lines (121 loc) · 5.49 KB
Raw

StorageApiSdk

Saves binary files in CDN providers for allowing later downloads

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

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/storage_api_sdk.git"
    }
  ],
  "require": {
    "softonic/storage_api_sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/StorageApiSdk/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: storage_api_access_code
$config = Softonic\StorageApiSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: storage_api_application
$config = Softonic\StorageApiSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: storage_api_implicit
$config = Softonic\StorageApiSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: storage_api_password
$config = Softonic\StorageApiSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Softonic\StorageApiSdk\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 of the file

try {
    $result = $apiInstance->readFile($id_files);
    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://storage-v2.eu-west.sftapi.com

Class Method HTTP request Description
FilesApi readFile GET /files/{id_files} Fetches a single File
FilesCdnDestinationsApi deleteFileCdnDestination DELETE /files/{id_files}/cdn-destinations/{id_cdn_destinations} Deletes a FileCdnDestination
FilesCdnDestinationsApi findFileCdnDestination GET /files/{id_files}/cdn-destinations List of FileCdnDestinations
UploadRequestsApi createUploadRequest POST /upload-requests Creates a new UploadRequest
UploadRequestsApi readUploadRequest GET /upload-requests/{id_upload_requests} Fetches a single UploadRequest

Documentation For Models

Documentation For Authorization

storage_api_access_code

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://oauth-v2.softonic.com/token
  • Scopes:
  • storage_api.read.files: Read Files
  • storage_api.read.uploadrequests: Read UploadRequests
  • storage_api.create.uploadrequests: Create UploadRequests
  • storage_api.delete.files.cdndestinations: Delete Files/CdnDestinations
  • storage_api.find.files.cdndestinations: Find Files/CdnDestinations

storage_api_application

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • storage_api.read.files: Read Files
  • storage_api.read.uploadrequests: Read UploadRequests
  • storage_api.create.uploadrequests: Create UploadRequests
  • storage_api.delete.files.cdndestinations: Delete Files/CdnDestinations
  • storage_api.find.files.cdndestinations: Find Files/CdnDestinations

storage_api_implicit

  • Type: OAuth
  • Flow: implicit
  • Authorization URL: https://oauth-v2.softonic.com/authorize
  • Scopes:
  • storage_api.read.files: Read Files
  • storage_api.read.uploadrequests: Read UploadRequests
  • storage_api.create.uploadrequests: Create UploadRequests
  • storage_api.delete.files.cdndestinations: Delete Files/CdnDestinations
  • storage_api.find.files.cdndestinations: Find Files/CdnDestinations

storage_api_password

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes:
  • storage_api.read.files: Read Files
  • storage_api.read.uploadrequests: Read UploadRequests
  • storage_api.create.uploadrequests: Create UploadRequests
  • storage_api.delete.files.cdndestinations: Delete Files/CdnDestinations
  • storage_api.find.files.cdndestinations: Find Files/CdnDestinations

Author

[email protected]