Download the PHP package newman/laravel-tms-api-client without Composer
On this page you can find all versions of the php package newman/laravel-tms-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-tms-api-client
Laravel Backscreen API Client
This package helps you to make API calls to Backscreen (a.k.a: Videosher, TET Media Services) API v5.
https://api.cloudycdn.services/api/v5/docs
Requirements
- Laravel 9.0+, 10.0+, 11.0+
- PHP 8.1+
Installation
Require the package via Composer:
Copy config file to your config
directory.
Add environment variables to your .env
file.
At last, you can add extra client to your tms-api.php
config file with other credentials or different default settings.
:book: Documentation & Usage
Clients
Access client from config
Create a client dynamically
We recommend to do this on your AppServiceProvider
, inside boot
function.
Authenticate via Bearer token
There are some endpoints (e.g. /User/Login
) which doesn't require any authentication at all.
Configure Client
Note: This will override settings for upcoming requests on default
client.
timeout
and connectTimeout
withMiddleware
Append HTTP middleware to this client upcoming requests.
https://laravel.com/docs/9.x/http-client#guzzle-middleware
Response
Response of the request is \Illuminate\Http\Client\Reponse
object.
Endpoints
We created this package with only few implementations of TMS endpoints. PRs are welcome to add more.
For each endpoint argument (except required ones) you'll find a correspoding setter function.
Here is the list of implemented endpoints:
/Token
Endpoint: /Token/Generate
https://api.cloudycdn.services/api/v5/docs#/operations/Token/Generate
Generates a new token.
Accepted Auth Methods: Basic
, Bearer token
, API Key
/Media
Endpoint: /Media/List
https://api.cloudycdn.services/api/v5/docs#/operations/Media/List
Retrieve a list of media.
Accepted Auth Methods: Basic
, Bearer token
, API Key
Endpoint: /Media/Create
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Create
Create media.
Accepted Auth Methods: Basic
, Bearer token
Endpoint: /Media/Update
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Update
Update media.
Accepted Auth Methods: Basic
, Bearer token
, API Key
Endpoint: /Media/Delete
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Delete
Delete media by ID/s.
Accepted Auth Methods: Basic
, Bearer token
Endpoint: /Media/Clone
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Clone
Clone media by ID.
Accepted Auth Methods: Basic
, Bearer token
Endpoint: /Media/Trim
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Trim
Accepted Auth Methods: Bearer token
Endpoint: /Media/Generateimage
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Generateimage
Accepted Auth Methods: Basic
, Bearer token
Endpoint: /Media/Reset
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Reset
Accepted Auth Methods: Bearer token
Endpoint: /Media/Transcode
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Transcode
Accepted Auth Methods: Bearer token
Endpoint: /Media/Canceltranscode
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Canceltranscode
Accepted Auth Methods: Bearer token
Endpoint: /Media/Updatesubtitlesfromsource
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Updatesubtitlesfromsource
Accepted Auth Methods: Bearer token
Endpoint: /Media/Regeneratepackages
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Regeneratepackages
Accepted Auth Methods: Bearer token
/Media/Manifest
Endpoint: /Media/Manifest/List
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Manifest/List
Retrieve list of manifests.
Accepted Auth Methods: Basic
, Bearer token
, API Key
Endpoint: /Media/Manifest/Create
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Manifest/Create
Create a new media manifest.
Accepted Auth Methods: Basic
, Bearer token
Endpoint: /Media/Manifest/Update
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Manifest/Update
Update media manifest by manifest ID.
Accepted Auth Methods: Basic
, Bearer token
Endpoint: /Media/Manifest/Delete
https://api.cloudycdn.services/api/v5/docs#/operations/Media/Manifest/Delete
Delete media manifest by manifest ID.
Accepted Auth Methods: Basic
, Bearer token
/User
Endpoint: /User/Get
https://api.cloudycdn.services/api/v5/docs#/operations/User/Get
Return current user info. Returns the same values as login action, but without auth_token.
Accepted Auth Methods: Bearer token
Endpoint: /User/Login
https://api.cloudycdn.services/api/v5/docs#/operations/User/Login
Login user by email & password to retrieve Bearer token.
Accepted Auth Methods: Null
Endpoint: /User/Logout
https://api.cloudycdn.services/api/v5/docs#/operations/User/Logout
Logout currently authenticated user.
Accepted Auth Methods: Bearer token
/Live
Endpoint: /Live/List
https://api.cloudycdn.services/api/v5/docs#/operations/Live/List
Retrieve a list of livestream.
Accepted Auth Methods: Basic
, Bearer token
, API Key
Endpoint: /Live/Create
https://api.cloudycdn.services/api/v5/docs#/operations/Live/Create
Create a livestream.
Accepted Auth Methods: Basic
, Bearer token
, API Key
Endpoint: /Live/Update
https://api.cloudycdn.services/api/v5/docs#/operations/Live/Update
Update an existing livestream.
Accepted Auth Methods: Basic
, Bearer token
, API Key
Endpoint: /Live/On
https://api.cloudycdn.services/api/v5/docs#/operations/Live/On
Turn on an existing livestream.
Accepted Auth Methods: Basic
, Bearer token
, API Key
Endpoint: /Live/Off
https://api.cloudycdn.services/api/v5/docs#/operations/Live/Off
Turn Off an existing livestream.
Accepted Auth Methods: Basic
, Bearer token
, API Key
Endpoint: /Live/Record
https://api.cloudycdn.services/api/v5/docs#/operations/Live/Record
Start recording an existing livestream.
Accepted Auth Methods: Basic
, Bearer token
, API Key
:handshake: Contributing
We'll appreciate your collaboration to this package.
When making pull requests, make sure:
- All tests are passing:
composer test
- Test coverage is not reduced:
composer test-coverage
- There are no PHPStan errors:
composer phpstan
- Coding standard is followed:
composer lint
orcomposer fix-style
to automatically fix it.
All versions of laravel-tms-api-client with dependencies
guzzlehttp/guzzle Version ^7.5
illuminate/contracts Version ^9.0|^10.0|^11.0
illuminate/http Version ^9.0|^10.0|^11.0
illuminate/support Version ^9.0|^10.0|^11.0
nesbot/carbon Version ^2.13|^3.0