Programmatic Ingest of Station Information
During the migration phase you can continue to send Station, Programme, and Now Playing information to the old system. We will forward all data to the new platform so that your information is available to the apps and web player.
However, you should plan to start sending your ingest data to the new platform. Your Country Manager will tell you when the old system will be retired so you can arrange for that to happen.
Authentication
You should authenticate your programmatic station/schedule submissions with a username/key combination encoded using BasicAuth. We will provide you with these details.
V1 Ingest endpoints
Radioplayer Cloud supports the legacy DAB EPG formats (v1.2 + Radioplayer extensions) to match the old platform. You can continue to send us your station information in those formats and we will process your data as before.
When sending us information in the legacy formats, please use the following endpoints:
Message Type | Endpoint |
Station Update (SI) | https://core-ingest.radioplayer.cloud/latest/{countryCode}/v1/si |
Programme Update (PI) | https://core-ingest.radioplayer.cloud/latest/{countryCode}/v1/pi |
On demand updates (OD) | https://core-ingest.radioplayer.cloud/latest/{countryCode}/v1/od |
Programme Events (PE) | https://core-ingest.radioplayer.cloud/latest/{countryCode}/v1/pe |
Replace {countryCode} with your territory’s ISO three digit country code. This allows you to continue to submit us information with RPIDs and we will translate them into RPUIDs.
For example, to send a station update for a station in Germany, one would use the URL
If you were to use cURL to submit a PI file to an ingest endpoint one would submit it as follows
curl -u youruser:yourpassword -X POST --header "Content-Type:text/xml;charset=UTF-8" -d @20220715_611_PI.xml https://core-ingest.radioplayer.cloud/latest/724/v1/pi Please use the new V2 Now Playing endpoint to submit your Now Playing information
Enhancements to V1 XML file processing
Genres
We support both legacy Genre term IDs and TV Anytime terms ids in the list of genres that can be attached to stations and programmes/ondemands.
See https://radioplayerworldwide.atlassian.net/wiki/spaces/RPC/pages/2007203853 for more details.
V2 Endpoints
Now Playing (NP)
The new API allows clients to submit a more concise form of NowPlaying data that is easier to manage - as an alternative to sending PE. Now Playing updates should be submitted to:
There are two ways this endpoint can be used; you can either incorporate your country code into the URL and use your old Radioplayer Station ID, or omit the country code and send us the new Radioplayer UID.
If you wish to incorporate the territory ID into the path then Now Playing events would be submitted to
The request parameters are as follows
id | optional | integer which can be used for de-duplication of requests |
rpuid | Required if no rpId and territory | The stations’ Radioplayer Unique ID number |
rpId | Required if no rpuid. If set the territory must also be included in the URL | The old Radioplayer classic station ID |
startTime | optional | the start time of the now playing data. We support the following date/time formats:
If omitted, then this defaults to ‘now’. |
duration | optional | The duration of the song in seconds. If omitted, the default value is 180 seconds |
title | required | The song title, max length is 128 characters |
artist | optional | The artist name, max length is 128 characters |
description | optional | An additional description. Max length is 180 characters |
imageUrl | optional | URL to an image that will be shown with this event and which you have permission to distribute. We prefer square images, and there is a minimum resolution of 600x600 - any smaller than that and we don’t use them as they don’t look good on apps and in car systems. |
Note that to maintain backwards compatibility with Radioplayer Classic, to submit a now playing event using a territory RPID rather than a Cloud RPUID, you must use the parameter rpId - note the capitalisation - for the request to be successfully authenticated.
A template example of how you could post this data using the commonly found 'curl' command line utility follows:
curl -u yourusername:yourpassword -v -X POST "https://np-ingest.radioplayer.cloud?rpuid=YOUR_RPUID&startTime=2022-07-04T15:00:00&duration=600&title=SONGTITLE&artist=ARTIST"To send it using the RP Classic style endpoint, use the following
curl -u yourusername:yourpassword -v -X POST "https://np-ingest.radioplayer.cloud/826?rpId=YOUR_RPID&startTime=2022-07-04T15:00:00&duration=600&title=SONGTITLE&artist=ARTIST"Station and Schedule Updates
The new ingest endpoints are as follows:
Message Type | Endpoint |
Station Update (SI) | |
Programme Update (PI) | |
On demand updates (OD) | |
Programme Events (PE) |
These endpoints support the legacy DAB EPG formats and the v3.1.1 version of the DAB EPG specification. However, as this URL does not include the country code, all station identifiers must be updated to use the rpuid even if you are sending us information in the legacy format
For reference, a link to the DAB EPG spec is as below
Data should be POSTed to these endpoints. The XML should be request body.
The difference between the legacy DAB EPG specification and the v3.1.1 version are described in the DAB EPG Spec Migration Guide.
To use the latest version 3.1, please define the main XML namespace as
If you are posting data to us in the 3.1 format you will need to define the Radioplayer namespace in the XML tag, so that you can define the Radioplayer RPUID, as follows:
If you are using the old format, continue to define the namespace as before, e.g.
Image sizes
When you send station images, you can provide us just high quality square (1400x1400) and landscape (1920x1080) images and we will generate smaller versions of them by cropping them (if necessary) and shrinking them down. Contact your country manager if you want to do this so we can configure our system to do it for you. Alternatively, send all images and we will attach them to your station.
When you send a station update, we will only reprocess images if they are included in the station record. If you do not include an image, we will leave the previous one as it is.
For schedule updates, please provide the following images sizes to guarantee that the correct imagery is available throughout our products
600x600 - used in the “Now Playing” window on the web console and in the apps - in the schedule view and in now playing (if there is no track image available)
288x162 - used in the schedule view of the web console