crossclear

Cross Karaoke App Api
 0.1.alpha_1 
OAS3

sandbox-api-karaoke.yml

Karaoke App Api

Note: change https://sandbox-api.karaoke.crossclear.com/api/v1/apps to https://api.karaoke.crossclear.com/api/v1/apps for production api calls

Authorization

Add the following HTTP header to your request to pass the authentication: "Authorization: Bearer {authToken}"

Server

Repertoire

GET/repertoire/download
Returns signed url, that can be used to download repertoir.
GET/identification-types
Returns list of identification types.

TransactionsReports

POST/transactions-reports/upload
Returns url, that can be used to upload on transactions
POST/transactions-reports/{transaction-report-id}/uploaded
Mark report as uploaded.
GET/transactions-reports/{transaction-report-id}
Inspect report import progress.

GlobalAdModelRevenue

GET/advertisement-revenues/global-ad-revenue-reports
List global advertisement model revenues.
POST/advertisement-revenues/global-ad-revenue-reports
Create global advertisement model revenue record
GET/advertisement-revenues/global-ad-revenue-reports/{id}
Get global advertisement model revenue record
PUT/advertisement-revenues/global-ad-revenue-reports/{id}
Create global advertisement model revenue record
DELETE/advertisement-revenues/global-ad-revenue-reports/{id}
destroy global advertisement model revenue record

AssetBasedAdModelRevenue

GET/advertisement-revenues/asset-based-ad-revenue-reports/
List asset-based advertisement model revenues.
POST/advertisement-revenues/asset-based-ad-revenue-reports
Returns created revenue report record. Created revenue report record will have signed url, that should be used to upload revenue report. Revenue report should be uploaded with an additional query. Revenue report file appears to be a set on text lines, each line appears to be a json object of [AssetBasedRevenueReportLine](#model-AssetBasedRevenueReportLine) format.
GET/advertisement-revenues/asset-based-ad-revenue-reports/{id}
Get asset-based advertisement model revenue record
PUT/advertisement-revenues/asset-based-ad-revenue-reports/{id}
Create asset-based advertisement model revenue record
DELETE/advertisement-revenues/asset-based-ad-revenue-reports/{id}
destroy asset-based advertisement model revenue record
POST/advertisement-revenues/asset-based-ad-revenue-reports/{id}/uploaded
Notify server, that revenue report has been uploaded

AssetBasedAdModelRevenueLine

GET/advertisement-revenues/asset-based-ad-revenue-reports/{report-id}/lines
List asset-based advertisement model revenues.
GET/advertisement-revenues/asset-based-ad-revenue-reports/{report-id}/lines/{line-id}
Get asset-based advertisement model revenue record

Models

Error
RepertoireDownloadResponse
RepertoireRecording
TransactionsReportUploadResponse
TransactionsReportLine
TransactionImportReportLineImportResultSuccess
TransactionImportReportLineImportResultError
TransactionImportReportLineWrongFormatError
ImportResultSuccess
ImportResultError
WrongFormatImportResultError
IdentificationTypesShowResponce
GlobalAdvertisementModelRevenue
CreateGlobalAdvertisementModelRevenueBody
UpdateGlobalAdvertisementModelRevenueBody
AssetBasedAdvertisementModelRevenue
CreateAssetBasedAdvertisementModelRevenueBody
UpdateAssetBasedAdvertisementModelRevenueBody
AssetBasedRevenueReportLine
AssetBasedReportImportLineImportResultSuccess
AssetBasedReportImportLineImportResultError
AssetBasedReportImportLineWrongFormatError
AssetBasedAdvertisementModelRevenueLine