akbansa/gumlet-php-sdk

Use Gumlet SDK to upload videos to Gumlet, manage channel & playlist, create image source, and get analytics

1.0.1 2025-05-15 11:46 UTC

Requires

• php: ^7.2 || ^8.0
• ext-curl: *
• ext-json: *
• apimatic/core: ~0.3.13
• apimatic/core-interfaces: ~0.1.5
• apimatic/unirest-php: ^4.0.6

Requires (Dev)

• phan/phan: 5.4.5
• phpunit/phpunit: ^7.5 || ^8.5 || ^9.5
• squizlabs/php_codesniffer: ^3.5

MIT

• akbansa

• Image API
• gumlet
• video api
• video security
• video analytics

README

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "akbansa/gumlet-php-sdk:1.0.1"

Or add it to the composer.json file manually as given below:

"require": {
    "akbansa/gumlet-php-sdk": "1.0.1"
}

You can also view the package at: https://packagist.org/packages/akbansa/gumlet-php-sdk#1.0.1

Test the SDK

Unit tests in this SDK can be run using PHPUnit.

1. First install the dependencies using composer including the require-dev dependencies.
2. Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
timeout	int	Timeout for API calls in seconds. Default: 0
enableRetries	bool	Whether to enable retries and backoff feature. Default: false
numberOfRetries	int	The number of retries to make. Default: 0
retryInterval	float	The retry time interval between the endpoint calls. Default: 1
backOffFactor	float	Exponential backoff factor to increase interval between retries. Default: 2
maximumRetryWaitTime	int	The maximum wait time in seconds for overall retrying requests. Default: 0
retryOnTimeout	bool	Whether to retry on request timeout. Default: true
httpStatusCodesToRetry	array	Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524
httpMethodsToRetry	array	Http methods to retry against. Default: 'GET', 'PUT'
proxyConfiguration	ProxyConfigurationBuilder	Represents the proxy configurations for API calls
customHeaderAuthenticationCredentials	CustomHeaderAuthenticationCredentials	The Credentials Setter for Custom Header Signature

The API client can be initialized as follows:

$client = GumletRestApisClientBuilder::init()
    ->customHeaderAuthenticationCredentials(
        CustomHeaderAuthenticationCredentialsBuilder::init(
            'Authorization'
        )
    )
    ->build();

Authorization

This API uses the following authentication schemes.

• sec0 (Custom Header Signature)

List of APIs

• API Endpoints

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder

HTTP

• HttpRequest
• HttpResponse

Utilities

• ApiException