README

Pluxbox RadioManager gives you the power, flexibility and speed you always wanted in a lightweight and easy-to-use web-based radio solution. With Pluxbox RadioManager you can organise your radio workflow and automate your omnichannel communication with your listeners. We offer wide range specialised services for the radio and connections like Hybrid Radio, Visual Radio, your website and social media without losing focus on your broadcast. For more information visit: pluxbox.com

API version: 2.0
Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit https://pluxbox.com

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/pluxbox/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "pluxbox/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/RadioManager/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure API key authorization: API Key
$config = RadioManager\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BlockApi(
    // 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
);
$id = 789; // int | ID of Block **(Required)**
$_external_station_id = 789; // int | Query on a different (content providing) station *(Optional)*

try {
    $result = $apiInstance->getBlockById($id, $_external_station_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BlockApi->getBlockById: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://radiomanager.io/api/v2

Class	Method	HTTP request	Description
BlockApi	getBlockById	GET /blocks/{id}	Get block by id
BlockApi	getCurrentBlock	GET /blocks/current	Get current Block
BlockApi	getNextBlock	GET /blocks/next	Get upcoming Block
BlockApi	listBlocks	GET /blocks	Get a list of all blocks currently in your station.
BroadcastApi	createBroadcast	POST /broadcasts	Create broadcast.
BroadcastApi	deleteBroadcastById	DELETE /broadcasts/{id}	Delete broadcast by id
BroadcastApi	getBroadcastById	GET /broadcasts/{id}	Get broadcast by id
BroadcastApi	getCurrentBroadcast	GET /broadcasts/current	Get current Broadcast
BroadcastApi	getDailyEPG	GET /broadcasts/epg/daily	Get daily EPG
BroadcastApi	getEPGByDate	GET /broadcasts/epg	Get EPG by date
BroadcastApi	getNextBroadcast	GET /broadcasts/next	Get next Broadcast
BroadcastApi	getWeeklyEPG	GET /broadcasts/epg/weekly	Get weekly EPG
BroadcastApi	listBroadcasts	GET /broadcasts	Get all broadcasts.
BroadcastApi	printBroadcastById	GET /broadcasts/print/{id}	Print broadcast by id with template
BroadcastApi	updateBroadcastByID	PATCH /broadcasts/{id}	Update broadcast by id
CampaignApi	createCampaign	POST /campaigns	Create campaign.
CampaignApi	deleteCampaignById	DELETE /campaigns/{id}	Delete campaign by id
CampaignApi	getCampaignById	GET /campaigns/{id}	Get campaign by id
CampaignApi	listCampaigns	GET /campaigns	Get all campaigns.
CampaignApi	updateCampaignByID	PATCH /campaigns/{id}	Update campaign by id
ContactApi	createContact	POST /contacts	Create contact.
ContactApi	deleteContactById	DELETE /contacts/{id}	Delete contact by id
ContactApi	getContactById	GET /contacts/{id}	Get contact by id
ContactApi	listContacts	GET /contacts	Get all contacts.
ContactApi	updateContactByID	PATCH /contacts/{id}	Update contact by id
GenreApi	getGenreById	GET /genres/{id}	Get genre by id
GenreApi	listGenres	GET /genres	List all genres.
ItemApi	createItem	POST /items	Create an new item.
ItemApi	currentItemPostStructure	POST /items/current/structure	Post a current playing item, keep structure
ItemApi	currentItemPostTiming	POST /items/current/timing	Post a current playing item
ItemApi	deleteItemById	DELETE /items/{id}	Delete item by ID.
ItemApi	getCurrentItem	GET /items/current	Get current Item
ItemApi	getItemById	GET /items/{id}	Get extended item details by ID.
ItemApi	listItems	GET /items	Get a list of all the items currently in your station.
ItemApi	playlistPostMerge	POST /items/playlist/merge	Post a playlist, do not remove previously imported items
ItemApi	playlistPostStructure	POST /items/playlist/structure	Post a playlist, keep current structure
ItemApi	playlistPostTiming	POST /items/playlist/timing	Post a playlist
ItemApi	stopCurrentItem	POST /items/stopcurrent	Stop an Item
ItemApi	updateItemById	PATCH /items/{id}	Update extended item details by ID.
ModelTypeApi	getModelTypeById	GET /model_types/{id}	Get modelType by id
ModelTypeApi	listModelTypes	GET /model_types	Get all modelTypes.
PresenterApi	createPresenter	POST /presenters	Create presenter.
PresenterApi	deletePresenterById	DELETE /presenters/{id}	Delete presenter by id
PresenterApi	getPresenterById	GET /presenters/{id}	Get presenter by id
PresenterApi	listPresenters	GET /presenters	Get all presenters.
PresenterApi	updatePresenterByID	PATCH /presenters/{id}	Update presenter by id
ProgramApi	createProgram	POST /programs	Create program.
ProgramApi	deleteProgramById	DELETE /programs/{id}	Delete program by id
ProgramApi	getProgramById	GET /programs/{id}	Get program by id
ProgramApi	listPrograms	GET /programs	Get all programs.
ProgramApi	updateProgramByID	PATCH /programs/{id}	Update program by id
StationApi	getStation	GET /station	Get own station only
StoryApi	createStory	POST /stories	Create story.
StoryApi	deleteStoryById	DELETE /stories/{id}	Delete story by id
StoryApi	getStoryById	GET /stories/{id}	Get story by id
StoryApi	listStories	GET /stories	Get all stories.
StoryApi	updateStoryByID	PATCH /stories/{id}	Update story by id
StringApi	getStringsByName	GET /strings/{name}	Get Strings (formatted)
TagApi	createTag	POST /tags	Create tag.
TagApi	deleteTagById	DELETE /tags/{id}	Delete tag by id
TagApi	getTagById	GET /tags/{id}	Get tags by id
TagApi	listTags	GET /tags	Get a list of all the tags currently in your station.
TagApi	updateTagByID	PATCH /tags/{id}	Update tag by id
UserApi	deleteUserById	DELETE /users/{id}	Remove user from station by Id
UserApi	getUserById	GET /users/{id}	Get user by id
UserApi	inviteUserByMail	POST /users/invite	Invite user by mail
UserApi	listUsers	GET /users	Get all users.
VisualSlideApi	getVisualSlide	GET /visual	Get Visual Slide Image as Base64

Documentation For Models

Documentation For Authorization

API Key

Type: API key
API key parameter name: api-key
Location: HTTP header

Author

support@pluxbox.com

pluxbox / radiomanager-php-client

Maintainers

Details