README

Media Delivery API

For more information, please visit https://cloudinary.com.

Installation & Usage

Requirements

PHP 7.3 and later.

Composer

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

{
  "require": {
    "cloudinary/media-delivery-api": "*"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/media-delivery-api/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure Cloudinary URL: basicAuth
$config = Cloudinary\MediaDelivery\Configuration::getDefaultConfiguration()
              ->setCloudinaryUrl('cloudinary://key:secret@cloud_name');

$apiInstance = new Cloudinary\MediaDelivery\Api\CacheApi(null, $config);

$cache_invalidate_request_payload = new \Cloudinary\MediaDelivery\Model\CacheInvalidateRequestPayload(); // \Cloudinary\MediaDelivery\Model\CacheInvalidateRequestPayload | Payload to invalidate the cache

try {
    $apiInstance->invalidate($cache_invalidate_request_payload);
} catch (Exception $e) {
    echo 'Exception when calling CacheApi->invalidate: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.cloudinary.com/v2/demo

Class	Method	HTTP request	Description
CacheApi	invalidate	POST /media_delivery/cache/invalidate	Invalidate the cache
CacheApi	warmup	POST /media_delivery/cache/warmup	Warm up the cache
DeliveryProfileApi	createDeliveryProfile	POST /media_delivery/profiles	Create a new Delivery Profile
DeliveryProfileApi	deleteDeliveryProfile	DELETE /media_delivery/profiles/{id}	Delete the Delivery Profile
DeliveryProfileApi	getDeliveryProfile	GET /media_delivery/profiles/{id}	Get the Delivery Profile
DeliveryProfileApi	getDeliveryProfiles	GET /media_delivery/profiles	Get the Delivery Profiles
DeliveryProfileApi	updateDeliveryProfile	PATCH /media_delivery/profiles/{id}	Update the Delivery Profile
MappingFunctionApi	createMappingFunction	POST /media_delivery/mapping_functions	Create a new Mapping Function
MappingFunctionApi	deleteMappingFunction	DELETE /media_delivery/mapping_functions/{id}	Delete the Mapping Function
MappingFunctionApi	getMappingFunction	GET /media_delivery/mapping_functions/{id}	Get the Mapping Function
MappingFunctionApi	getMappingFunctions	GET /media_delivery/mapping_functions	Get the Mapping Functions
MappingFunctionApi	updateMappingFunction	PATCH /media_delivery/mapping_functions/{id}	Update the Mapping Function
MediaSourceApi	createMediaSource	POST /media_delivery/media_sources	Create a new Media Source
MediaSourceApi	deleteMediaSource	DELETE /media_delivery/media_sources/{id}	Delete the Media Source
MediaSourceApi	getMediaSource	GET /media_delivery/media_sources/{id}	Get the Media Source
MediaSourceApi	getMediaSources	GET /media_delivery/media_sources	Get the Media Sources
MediaSourceApi	updateMediaSource	PATCH /media_delivery/media_sources/{id}	Update the Media Source
MediaTargetApi	createMediaTarget	POST /media_delivery/media_targets	Create a new Media Target
MediaTargetApi	deleteMediaTarget	DELETE /media_delivery/media_targets/{id}	Delete the Media Target
MediaTargetApi	getMediaTarget	GET /media_delivery/media_targets/{id}	Get the Media Target
MediaTargetApi	getMediaTargets	GET /media_delivery/media_targets	Get the Media Targets
MediaTargetApi	updateMediaTarget	PATCH /media_delivery/media_targets/{id}	Update the Media Target

Models

Authorization

basicAuth

Type: HTTP basic authentication

bearerAuth

Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This Cloudinary PHP package is automatically generated.

API version: 0.1.0-beta
Build package: org.openapitools.codegen.languages.PhpClientCodegen

cloudinary / media-delivery-api

Maintainers

Details