README

The Media API lets sellers to create, upload, and retrieve files, including:

• videos
• documents (for GPSR regulations)

Installation & Usage

Requirements

PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/macropage/sdk-ebay-rest-media.git"
    }
  ],
  "require": {
    "macropage/sdk-ebay-rest-media": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/sdk-ebay-rest-media/vendor/autoload.php');

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: api_auth
$config = macropage\SDKs\ebay\rest\media\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new macropage\SDKs\ebay\rest\media\Api\DocumentApi(
    // 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
);
$contentType = 'contentType_example'; // string | This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\" target=\"_blank \">HTTP request headers</a>.
$createDocumentRequest = new \macropage\SDKs\ebay\rest\media\Model\CreateDocumentRequest(); // \macropage\SDKs\ebay\rest\media\Model\CreateDocumentRequest

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

API Endpoints

All URIs are relative to https://apim.ebay.com/commerce/media/v1_beta

Models

• CreateDocumentRequest
• CreateDocumentResponse
• CreateVideoRequest
• DocumentMetadata
• DocumentResponse
• Error
• ErrorParameter
• Image
• Moderation
• Play
• Video

Authorization

api_auth

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://auth.ebay.com/oauth2/authorize
• Scopes:
  • https://api.ebay.com/oauth/api_scope/sell.inventory: View and manage your inventory and offers

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: v1_beta.2.0
  • Package version: 2.3.2
• Build package: org.openapitools.codegen.languages.PhpClientCodegen