mediamaskio/mediamask-php

Mediamask PHP API Client for dynamic image generation

1.0.7 2022-09-02 12:16 UTC

Requires

• php: ^7.4 || ^8.0
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.3
• guzzlehttp/psr7: ^1.7 || ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.5
• phpunit/phpunit: ^8.0 || ^9.0

mit

• Gregor Vostrak

• php
• rest
• api
• sdk
• image-generation

README

This PHP Client supports the Mediamask POST API to generate dynamic images. You can find more information about the usage in our docs: https://docs.mediamask.io/docs/post-api.

Installation & Usage

Requirements

PHP 7.4 and later.

Composer

Install via Composer

Install the package into your project by using with Composer :

composer require mediamaskio/mediamask-php

### Manual Installation

Download the files and include `autoload.php`:

```php
<?php
require_once('/path/to/mediamask-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure Bearer authorization: bearerAuth
$config = Mediamask\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


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

// \OpenAPI\Client\Model\NewImage | Provide the template and placeholders values that should be rendered in the image
$new_image = {
    "template":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "placeholders": [
        {
            "name":"text placeholder name",
            "text":"an example text"
        },
        {
            "name":"image placeholder name",
            "image":"https://example.com/example.jpg"
            }
        ]
    }; 
try {
    $result = $apiInstance->renderImage($new_image);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediamaskApi->renderImage: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://mediamask.io/api/v1

Class	Method	HTTP request	Description
MediamaskApi	renderImage	POST /image	Render a new image
MediamaskApi	templates	GET /templates	Get all tempaltes

Models

• DynamicLayer
• Error
• ImagePlaceholder
• NewImage
• NewImagePlaceholdersInner
• Template
• Templates200Response
• TextPlaceholder
• ValidationError

Authorization

bearerAuth

• Type: Bearer authentication

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: 1.0.4
• Build package: org.openapitools.codegen.languages.PhpClientCodegen