addvideo-api-php-client

Welcome to AddVideo | easy video integration into your project

AddVideo offers the integration of professional online video services and capabilities such as CDN, encoding, asset management and complex distribution workflows with your favourite CMS. AddVideo processes and distributes your video contents as required, without interface- or CDN-specific implementations. Using AddVideo you will get:

• API: a powerful REST-API with free client SDKs available in many different programming languages incl. examples at http://github.com/addvideo
• Encoding: media processing and video encoding services
• CDN: use diverse very powerful global CDNs to distribute your contents
• OTT: access to useful functionalities via the API
• Development, Service und Maintenance: our team of high class software engineers and online video specialists is located in Frankfurt/Germany
• Powerfull Infrastructure: system operations in high class data centres in Germany
• In General: a fast growing set of features

It has never been easier to add professional video modules to your platform on demand. AddVideo helps to slimline your integration efforts and provides the whole video workflow accessible through a simple programming interface.

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1
• Package version: 1.0.0
• Build date: 2016-12-23T13:48:03.811+01:00
• Build package: class io.swagger.codegen.languages.PhpClientCodegen For more information, please visit http://www.addvideo.de

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/addvideo/addvideo-api-php-client.git"
    }
  ],
  "require": {
    "addvideo/addvideo-api-php-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure API key authorization: token
de\addvideo\client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// de\addvideo\client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new de\addvideo\client\Api\AddvideoexportApi();
$body = new \de\addvideo\client\model\FTPCompletedExportFullDTO(); // \de\addvideo\client\model\FTPCompletedExportFullDTO | FTPCompletedExport object that shall be added

try {
    $result = $api_instance->addFTPCompletedExport($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddvideoexportApi->addFTPCompletedExport: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.addvideo.de/v1

Class	Method	HTTP request	Description
AddvideoexportApi	addFTPCompletedExport	POST /addvideo/export/ftp-completed-export/addFTPCompletedExport	Add a new FTPCompletedExport object
AddvideoexportApi	addFTPExportConfig	POST /addvideo/export/ftp-export-config/addFTPExportConfig	Add a new FTPExportConfig object
AddvideoexportApi	addS3CompletedExport	POST /addvideo/export/s3-completed-export/addS3CompletedExport	Add a new S3CompletedExport object
AddvideoexportApi	addS3ExportConfig	POST /addvideo/export/s3-export-config/addS3ExportConfig	Add a new S3ExportConfig object
AddvideoexportApi	deleteFTPCompletedExport	DELETE /addvideo/export/ftp-completed-export/deleteFTPCompletedExport/{id}	Delete FTPCompletedExport object matching the given id
AddvideoexportApi	deleteFTPExportConfig	DELETE /addvideo/export/ftp-export-config/deleteFTPExportConfig/{id}	Delete FTPExportConfig object matching the given id
AddvideoexportApi	deleteS3CompletedExport	DELETE /addvideo/export/s3-completed-export/deleteS3CompletedExport/{id}	Delete S3CompletedExport object matching the given id
AddvideoexportApi	deleteS3ExportConfig	DELETE /addvideo/export/s3-export-config/deleteS3ExportConfig/{id}	Delete S3ExportConfig object matching the given id
AddvideoexportApi	getFTPCompletedExport	GET /addvideo/export/ftp-completed-export/getFTPCompletedExport/{id}	Get FTPCompletedExport object for id
AddvideoexportApi	getFTPExportConfig	GET /addvideo/export/ftp-export-config/getFTPExportConfig/{id}	Get FTPExportConfig object for id
AddvideoexportApi	getS3CompletedExport	GET /addvideo/export/s3-completed-export/getS3CompletedExport/{id}	Get S3CompletedExport object for id
AddvideoexportApi	getS3ExportConfig	GET /addvideo/export/s3-export-config/getS3ExportConfig/{id}	Get S3ExportConfig object for id
AddvideoexportApi	listFTPCompletedExports	POST /addvideo/export/ftp-completed-export/listFTPCompletedExports	List FTPCompletedExport objects depending on filter
AddvideoexportApi	listFTPExportConfigs	POST /addvideo/export/ftp-export-config/listFTPExportConfigs	List FTPExportConfig objects depending on filter
AddvideoexportApi	listS3CompletedExports	POST /addvideo/export/s3-completed-export/listS3CompletedExports	List S3CompletedExport objects depending on filter
AddvideoexportApi	listS3ExportConfigs	POST /addvideo/export/s3-export-config/listS3ExportConfigs	List S3ExportConfig objects depending on filter
AddvideoexportApi	updateFTPCompletedExport	PUT /addvideo/export/ftp-completed-export/updateFTPCompletedExport/{id}	Update FTPCompletedExport object
AddvideoexportApi	updateFTPExportConfig	PUT /addvideo/export/ftp-export-config/updateFTPExportConfig/{id}	Update FTPExportConfig object
AddvideoexportApi	updateS3CompletedExport	PUT /addvideo/export/s3-completed-export/updateS3CompletedExport/{id}	Update S3CompletedExport object
AddvideoexportApi	updateS3ExportConfig	PUT /addvideo/export/s3-export-config/updateS3ExportConfig/{id}	Update S3ExportConfig object
AddvideoservicecdnApi	addCDN	POST /addvideo/service/cdn/cdn/addCDN	Add a new CDN object
AddvideoservicecdnApi	addCDNAccount	POST /addvideo/service/cdn/cdn-account/addCDNAccount	Add a new CDNAccount object
AddvideoservicecdnApi	addCDNService	POST /addvideo/service/cdn/cdn-service/addCDNService	Add a new CDNService object
AddvideoservicecdnApi	deleteCDN	DELETE /addvideo/service/cdn/cdn/deleteCDN/{id}	Delete CDN object matching the given id
AddvideoservicecdnApi	deleteCDNAccount	DELETE /addvideo/service/cdn/cdn-account/deleteCDNAccount/{id}	Delete CDNAccount object matching the given id
AddvideoservicecdnApi	deleteCDNService	DELETE /addvideo/service/cdn/cdn-service/deleteCDNService/{id}	Delete CDNService object matching the given id
AddvideoservicecdnApi	getCDN	GET /addvideo/service/cdn/cdn/getCDN/{id}	Get CDN object for id
AddvideoservicecdnApi	getCDNAccount	GET /addvideo/service/cdn/cdn-account/getCDNAccount/{id}	Get CDNAccount object for id
AddvideoservicecdnApi	getCDNService	GET /addvideo/service/cdn/cdn-service/getCDNService/{id}	Get CDNService object for id
AddvideoservicecdnApi	listCDNAccounts	POST /addvideo/service/cdn/cdn-account/listCDNAccounts	List CDNAccount objects depending on filter
AddvideoservicecdnApi	listCDNServices	POST /addvideo/service/cdn/cdn-service/listCDNServices	List CDNService objects depending on filter
AddvideoservicecdnApi	listCDNs	POST /addvideo/service/cdn/cdn/listCDNs	List CDN objects depending on filter
AddvideoservicecdnApi	updateCDN	PUT /addvideo/service/cdn/cdn/updateCDN/{id}	Update CDN object
AddvideoservicecdnApi	updateCDNAccount	PUT /addvideo/service/cdn/cdn-account/updateCDNAccount/{id}	Update CDNAccount object
AddvideoservicecdnApi	updateCDNService	PUT /addvideo/service/cdn/cdn-service/updateCDNService/{id}	Update CDNService object
AddvideoserviceencodingApi	addEncodingService	POST /addvideo/service/encoding/encoding-service/addEncodingService	Add a new EncodingService object
AddvideoserviceencodingApi	addFFMPEGEncodingFlavor	POST /addvideo/service/encoding/ffmpeg-encoding-flavor/addFFMPEGEncodingFlavor	Add a new FFMPEGEncodingFlavor object
AddvideoserviceencodingApi	deleteEncodingService	DELETE /addvideo/service/encoding/encoding-service/deleteEncodingService/{id}	Delete EncodingService object matching the given id
AddvideoserviceencodingApi	deleteFFMPEGEncodingFlavor	DELETE /addvideo/service/encoding/ffmpeg-encoding-flavor/deleteFFMPEGEncodingFlavor/{id}	Delete FFMPEGEncodingFlavor object matching the given id
AddvideoserviceencodingApi	getEncodingService	GET /addvideo/service/encoding/encoding-service/getEncodingService/{id}	Get EncodingService object for id
AddvideoserviceencodingApi	getFFMPEGEncodingFlavor	GET /addvideo/service/encoding/ffmpeg-encoding-flavor/getFFMPEGEncodingFlavor/{id}	Get FFMPEGEncodingFlavor object for id
AddvideoserviceencodingApi	listEncodingServices	POST /addvideo/service/encoding/encoding-service/listEncodingServices	List EncodingService objects depending on filter
AddvideoserviceencodingApi	listFFMPEGEncodingFlavors	POST /addvideo/service/encoding/ffmpeg-encoding-flavor/listFFMPEGEncodingFlavors	List FFMPEGEncodingFlavor objects depending on filter
AddvideoserviceencodingApi	updateEncodingService	PUT /addvideo/service/encoding/encoding-service/updateEncodingService/{id}	Update EncodingService object
AddvideoserviceencodingApi	updateFFMPEGEncodingFlavor	PUT /addvideo/service/encoding/ffmpeg-encoding-flavor/updateFFMPEGEncodingFlavor/{id}	Update FFMPEGEncodingFlavor object
AddvideoservicemamApi	addEntry	POST /addvideo/service/mam/entry/addEntry	Add a new Entry object
AddvideoservicemamApi	addFlavor	POST /addvideo/service/mam/flavor/addFlavor	Add a new Flavor object
AddvideoservicemamApi	addMAMService	POST /addvideo/service/mam/mam-service/addMAMService	Add a new MAMService object
AddvideoservicemamApi	addMetadata	POST /addvideo/service/mam/metadata/addMetadata	Add a new Metadata object
AddvideoservicemamApi	deleteEntry	DELETE /addvideo/service/mam/entry/deleteEntry/{id}	Delete Entry object matching the given id
AddvideoservicemamApi	deleteFlavor	DELETE /addvideo/service/mam/flavor/deleteFlavor/{id}	Delete Flavor object matching the given id
AddvideoservicemamApi	deleteMAMService	DELETE /addvideo/service/mam/mam-service/deleteMAMService/{id}	Delete MAMService object matching the given id
AddvideoservicemamApi	deleteMetadata	POST /addvideo/service/mam/metadata/deleteMetadata	Delete Metadata object matching the given id
AddvideoservicemamApi	getEntry	GET /addvideo/service/mam/entry/getEntry/{id}	Get Entry object for id
AddvideoservicemamApi	getFlavor	GET /addvideo/service/mam/flavor/getFlavor/{id}	Get Flavor object for id
AddvideoservicemamApi	getMAMService	GET /addvideo/service/mam/mam-service/getMAMService/{id}	Get MAMService object for id
AddvideoservicemamApi	getMetadata	POST /addvideo/service/mam/metadata/getMetadata	Get Metadata object for id
AddvideoservicemamApi	listEntries	POST /addvideo/service/mam/entry/listEntries	List Entry objects depending on filter
AddvideoservicemamApi	listFlavors	POST /addvideo/service/mam/flavor/listFlavors	List Flavor objects depending on filter
AddvideoservicemamApi	listMAMServices	POST /addvideo/service/mam/mam-service/listMAMServices	List MAMService objects depending on filter
AddvideoservicemamApi	listMetadatas	POST /addvideo/service/mam/metadata/listMetadatas	List Metadata objects depending on filter
AddvideoservicemamApi	updateEntry	PUT /addvideo/service/mam/entry/updateEntry/{id}	Update Entry object
AddvideoservicemamApi	updateFlavor	PUT /addvideo/service/mam/flavor/updateFlavor/{id}	Update Flavor object
AddvideoservicemamApi	updateMAMService	PUT /addvideo/service/mam/mam-service/updateMAMService/{id}	Update MAMService object
AddvideoservicemamApi	updateMetadata	POST /addvideo/service/mam/metadata/updateMetadata	Update Metadata object
AddvideoworkflowApi	getPlayoutURLs	GET /addvideo/workflow/playout/getPlayoutURLs/{entry-id}	Get playout URLs for specififc entry.
AddvideoworkflowApi	getVideoPreviewThumbnailsURLs	GET /addvideo/workflow/playout/getVideoPreviewThumbnailsURLs/{entry-id}	Get video preview thumbnails URLs for specififc entry.
AddvideoworkflowApi	ingest	POST /addvideo/workflow/ingest/createJob	Ingest new video
AddvideoworkflowApi	status	GET /addvideo/workflow/ingest/status/{ingest-job-id}	Get status for ingest job
AuthApi	addAccountSecret	POST /auth/account-secret/addAccountSecret	Add a new AccountSecret object
AuthApi	addRole	POST /auth/role/addRole	Add a new Role object
AuthApi	authenticate	POST /auth/session/authenticate	Authenticates credentials.
AuthApi	deleteAccountSecret	POST /auth/account-secret/deleteAccountSecret	Delete AccountSecret object matching the given id
AuthApi	deleteRole	DELETE /auth/role/deleteRole/{id}	Delete Role object matching the given id
AuthApi	getAccountSecret	POST /auth/account-secret/getAccountSecret	Get AccountSecret object for id
AuthApi	getRole	GET /auth/role/getRole/{id}	Get Role object for id
AuthApi	listAccountSecrets	POST /auth/account-secret/listAccountSecrets	List AccountSecret objects depending on filter
AuthApi	listRoles	POST /auth/role/listRoles	List Role objects depending on filter
AuthApi	updateAccountSecret	POST /auth/account-secret/updateAccountSecret	Update AccountSecret object
AuthApi	updateRole	PUT /auth/role/updateRole/{id}	Update Role object
CrmcontactApi	addAddress	POST /crm/contact/address/addAddress	Add a new Address object
CrmcontactApi	addCompany	POST /crm/contact/company/addCompany	Add a new Company object
CrmcontactApi	addCompanyContact	POST /crm/contact/company-contact/addCompanyContact	Add a new CompanyContact object
CrmcontactApi	addContact	POST /crm/contact/contact/addContact	Add a new Contact object
CrmcontactApi	addCountry	POST /crm/contact/country/addCountry	Add a new Country object
CrmcontactApi	addTitle	POST /crm/contact/title/addTitle	Add a new Title object
CrmcontactApi	deleteAddress	DELETE /crm/contact/address/deleteAddress/{id}	Delete Address object matching the given id
CrmcontactApi	deleteCompany	DELETE /crm/contact/company/deleteCompany/{id}	Delete Company object matching the given id
CrmcontactApi	deleteCompanyContact	POST /crm/contact/company-contact/deleteCompanyContact	Delete CompanyContact object matching the given id
CrmcontactApi	deleteContact	DELETE /crm/contact/contact/deleteContact/{id}	Delete Contact object matching the given id
CrmcontactApi	deleteCountry	DELETE /crm/contact/country/deleteCountry/{id}	Delete Country object matching the given id
CrmcontactApi	deleteTitle	DELETE /crm/contact/title/deleteTitle/{id}	Delete Title object matching the given id
CrmcontactApi	getAddress	GET /crm/contact/address/getAddress/{id}	Get Address object for id
CrmcontactApi	getCompany	GET /crm/contact/company/getCompany/{id}	Get Company object for id
CrmcontactApi	getCompanyContact	POST /crm/contact/company-contact/getCompanyContact	Get CompanyContact object for id
CrmcontactApi	getContact	GET /crm/contact/contact/getContact/{id}	Get Contact object for id
CrmcontactApi	getCountry	GET /crm/contact/country/getCountry/{id}	Get Country object for id
CrmcontactApi	getTitle	GET /crm/contact/title/getTitle/{id}	Get Title object for id
CrmcontactApi	listAddresses	POST /crm/contact/address/listAddresses	List Address objects depending on filter
CrmcontactApi	listCompanies	POST /crm/contact/company/listCompanies	List Company objects depending on filter
CrmcontactApi	listCompanyContacts	POST /crm/contact/company-contact/listCompanyContacts	List CompanyContact objects depending on filter
CrmcontactApi	listContacts	POST /crm/contact/contact/listContacts	List Contact objects depending on filter
CrmcontactApi	listCountries	POST /crm/contact/country/listCountries	List Country objects depending on filter
CrmcontactApi	listTitles	POST /crm/contact/title/listTitles	List Title objects depending on filter
CrmcontactApi	updateAddress	PUT /crm/contact/address/updateAddress/{id}	Update Address object
CrmcontactApi	updateCompany	PUT /crm/contact/company/updateCompany/{id}	Update Company object
CrmcontactApi	updateCompanyContact	POST /crm/contact/company-contact/updateCompanyContact	Update CompanyContact object
CrmcontactApi	updateContact	PUT /crm/contact/contact/updateContact/{id}	Update Contact object
CrmcontactApi	updateCountry	PUT /crm/contact/country/updateCountry/{id}	Update Country object
CrmcontactApi	updateTitle	PUT /crm/contact/title/updateTitle/{id}	Update Title object
CrmcontractApi	addContract	POST /crm/contract/contract/addContract	Add a new Contract object
CrmcontractApi	addContractLine	POST /crm/contract/contract-line/addContractLine	Add a new ContractLine object
CrmcontractApi	addContractType	POST /crm/contract/contract-type/addContractType	Add a new ContractType object
CrmcontractApi	addCustomer	POST /crm/contract/customer/addCustomer	Add a new Customer object
CrmcontractApi	deleteContract	DELETE /crm/contract/contract/deleteContract/{id}	Delete Contract object matching the given id
CrmcontractApi	deleteContractLine	DELETE /crm/contract/contract-line/deleteContractLine/{id}	Delete ContractLine object matching the given id
CrmcontractApi	deleteContractType	DELETE /crm/contract/contract-type/deleteContractType/{id}	Delete ContractType object matching the given id
CrmcontractApi	deleteCustomer	DELETE /crm/contract/customer/deleteCustomer/{id}	Delete Customer object matching the given id
CrmcontractApi	getContract	GET /crm/contract/contract/getContract/{id}	Get Contract object for id
CrmcontractApi	getContractLine	GET /crm/contract/contract-line/getContractLine/{id}	Get ContractLine object for id
CrmcontractApi	getContractType	GET /crm/contract/contract-type/getContractType/{id}	Get ContractType object for id
CrmcontractApi	getCustomer	GET /crm/contract/customer/getCustomer/{id}	Get Customer object for id
CrmcontractApi	listContractLines	POST /crm/contract/contract-line/listContractLines	List ContractLine objects depending on filter
CrmcontractApi	listContractTypes	POST /crm/contract/contract-type/listContractTypes	List ContractType objects depending on filter
CrmcontractApi	listContracts	POST /crm/contract/contract/listContracts	List Contract objects depending on filter
CrmcontractApi	listCustomers	POST /crm/contract/customer/listCustomers	List Customer objects depending on filter
CrmcontractApi	updateContract	PUT /crm/contract/contract/updateContract/{id}	Update Contract object
CrmcontractApi	updateContractLine	PUT /crm/contract/contract-line/updateContractLine/{id}	Update ContractLine object
CrmcontractApi	updateContractType	PUT /crm/contract/contract-type/updateContractType/{id}	Update ContractType object
CrmcontractApi	updateCustomer	PUT /crm/contract/customer/updateCustomer/{id}	Update Customer object

Documentation For Models

• APIResultDTO
• AccountSecretFullDTO
• AccountSecretFullDTOListResult
• AccountSecretIdDTO
• AddressFullDTO
• AddressFullDTOListResult
• AddressIdDTO
• AttributeFilterDTO
• AuthenticationResultDTO
• CDNAccountFullDTO
• CDNAccountFullDTOListResult
• CDNAccountIdDTO
• CDNFullDTO
• CDNFullDTOListResult
• CDNIdDTO
• CDNServiceFullDTO
• CDNServiceFullDTOListResult
• CompanyContactFullDTO
• CompanyContactFullDTOListResult
• CompanyContactIdDTO
• CompanyFullDTO
• CompanyFullDTOListResult
• CompanyIdDTO
• CompletedExportIdDTO
• ContactFullDTO
• ContactFullDTOListResult
• ContactIdDTO
• ContractFullDTO
• ContractFullDTOListResult
• ContractIdDTO
• ContractLineFullDTO
• ContractLineFullDTOListResult
• ContractLineIdDTO
• ContractTypeFullDTO
• ContractTypeFullDTOListResult
• ContractTypeIdDTO
• CountryFullDTO
• CountryFullDTOListResult
• CountryIdDTO
• CredentialsDTO
• CustomerFullDTO
• CustomerFullDTOListResult
• CustomerIdDTO
• DimensionsDTO
• EncodingFlavorIdDTO
• EncodingServiceFullDTO
• EncodingServiceFullDTOListResult
• EntryFullDTO
• EntryFullDTOListResult
• EntryIdDTO
• ExportConfigIdDTO
• FFMPEGEncodingFlavorFullDTO
• FFMPEGEncodingFlavorFullDTOListResult
• FTPCompletedExportFullDTO
• FTPCompletedExportFullDTOListResult
• FTPExportConfigFullDTO
• FTPExportConfigFullDTOListResult
• FlavorFullDTO
• FlavorFullDTOListResult
• FlavorIdDTO
• IngestDataDTO
• IngestDataEntryDTO
• IngestResultDTO
• IngestStatusDTO
• IngestStatusEntryDTO
• MAMServiceFullDTO
• MAMServiceFullDTOListResult
• MetadataFullDTO
• MetadataFullDTOListResult
• MetadataIdDTO
• PaginatorDTO
• PlayoutURLDTO
• PlayoutURLsDTO
• ResultFilterDTO
• RoleFullDTO
• RoleFullDTOListResult
• RoleIdDTO
• S3CompletedExportFullDTO
• S3CompletedExportFullDTOListResult
• S3ExportConfigFullDTO
• S3ExportConfigFullDTOListResult
• TitleFullDTO
• TitleFullDTOListResult
• TitleIdDTO
• VideoPreviewThumbnailURLDTO
• VideoPreviewThumbnailsURLsDTO

Documentation For Authorization

token

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author

[email protected]