/ddb-cover-service-upload-php-client

Primary LanguagePHPGNU Affero General Public License v3.0AGPL-3.0

The service is provided by Danskernes Digitale Bibliotek

GNU Affero General Public License

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

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

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/danskernesdigitalebibliotek/ddb-cover-service-upload-php-client.git"
    }
  ],
  "require": {
    "danskernesdigitalebibliotek/ddb-cover-service-upload-php-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to//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: oauth
$config = CoverServiceUpload\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new CoverServiceUpload\Api\CoverApi(
    // 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
);

try {
    $result = $apiInstance->getCoverCollection();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoverApi->getCoverCollection: ', $e->getMessage(), PHP_EOL;
}

// Configure OAuth2 access token for authorization: oauth
$config = CoverServiceUpload\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new CoverServiceUpload\Api\CoverApi(
    // 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 = "id_example"; // string | 

try {
    $result = $apiInstance->getCoverItem($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoverApi->getCoverItem: ', $e->getMessage(), PHP_EOL;
}

// Configure OAuth2 access token for authorization: oauth
$config = CoverServiceUpload\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new CoverServiceUpload\Api\CoverApi(
    // 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
);
$cover = "cover_example"; // string | 

try {
    $result = $apiInstance->postCoverCollection($cover);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoverApi->postCoverCollection: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to /

Class Method HTTP request Description
CoverApi getCoverCollection GET /api/covers Retrieves the collection of Cover resources.
CoverApi getCoverItem GET /api/covers/{id} Retrieves a Cover resource.
CoverApi postCoverCollection POST /api/covers Creates a Cover resource.
MaterialApi deleteMaterialItem DELETE /api/materials/{id} Removes the Material resource.
MaterialApi getMaterialCollection GET /api/materials Retrieves the collection of Material resources.
MaterialApi getMaterialItem GET /api/materials/{id} Retrieves a Material resource.
MaterialApi postMaterialCollection POST /api/materials Creates a Material resource.

Documentation For Models

Documentation For Authorization

oauth

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes:
  • ****:

Author