Radionomy Board
It is currently Sun Nov 17, 2019 12:56 pm

All times are UTC




Forum locked This topic is locked, you cannot edit posts or make further replies.  [ 12 posts ]  Go to page 1, 2  Next
Author Message
PostPosted: Fri Oct 04, 2013 8:22 am 
Offline
Moderators
User avatar

Joined: Mon Jun 24, 2013 3:35 pm
Posts: 1629
Location: Nancy
Radio 1: http://listen.radionomy.com/BMC
O.S: Windows 8
:: FAQ - API (List of questions concerning API's) ::

Here is the list of the most frequently asked questions concerning the use of Radionomy API's :



Top
 Profile Send private message  
 
 Post subject: 1- What is an API ?
PostPosted: Fri Oct 04, 2013 8:27 am 
Offline
Moderators
User avatar

Joined: Mon Jun 24, 2013 3:35 pm
Posts: 1629
Location: Nancy
Radio 1: http://listen.radionomy.com/BMC
O.S: Windows 8
:: 1- What is an API ? ::

An API (Application Programming Interface) is a method set of functions offering access to certains data, in order to be used by third-party software.


Top
 Profile Send private message  
 
PostPosted: Fri Oct 04, 2013 8:33 am 
Offline
Moderators
User avatar

Joined: Mon Jun 24, 2013 3:35 pm
Posts: 1629
Location: Nancy
Radio 1: http://listen.radionomy.com/BMC
O.S: Windows 8
:: 2- Does the API usage require specific knowledge ? ::

A minimal knowledge (HTML, PHP,..) is required in order to use the API properly. False use can lead to getting your ApiKey "Blacklisted".

(If you do not have any knowledge in these different languages, and you want to get your current song title on your site; click here... )


Top
 Profile Send private message  
 
PostPosted: Fri Oct 04, 2013 8:47 am 
Offline
Moderators
User avatar

Joined: Mon Jun 24, 2013 3:35 pm
Posts: 1629
Location: Nancy
Radio 1: http://listen.radionomy.com/BMC
O.S: Windows 8
:: What are the APIs that Radionomy offer you ? ::

Radionomy offer you 6 different APIs :

- API Current Song : allows you to display current played track on your radio, and its cover art.

- API Current Audience : allows you to dispaly the current audience of your radio.

- API Tracklist : allows you to display the last played tracks on your radio station, (maximum 50)

- API Top Tracks : allows you to display the most played tracks on your radio station, for a specified period

- API Radio News : allows you to display the latest news of your radio published on your page at http://www.radionomy.com

- API Baracoda * : allows you to provide to OrangeLive or RadioMee the XML information concerning your radio

* The Baracoda API, does not have to get used form yours. You have only to transmit it while you reference your radio there.


Top
 Profile Send private message  
 
PostPosted: Fri Oct 04, 2013 8:54 am 
Offline
Moderators
User avatar

Joined: Mon Jun 24, 2013 3:35 pm
Posts: 1629
Location: Nancy
Radio 1: http://listen.radionomy.com/BMC
O.S: Windows 8
:: Is there any prerequisite to use the API ? ::

In order to use the API's (besides Baracoda API), you must get :
- a dynamic web hosting (PHP5), mutualized or dedicated,
- get the unique radio identity (RadioUid),
- get your ApiKey (Where can i find my ApiKey), that allows you the use of the APIs.


Top
 Profile Send private message  
 
PostPosted: Fri Oct 04, 2013 8:55 am 
Offline
Moderators
User avatar

Joined: Mon Jun 24, 2013 3:35 pm
Posts: 1629
Location: Nancy
Radio 1: http://listen.radionomy.com/BMC
O.S: Windows 8
:: Where can i find my RadiouUid? ::

What is the RadioUid Of a radio ?

The RadioUid is an unique and individual username for each radio. This code allows you to be exactly and specifically identified on the Radionomy plateform.

What is the difference, why the ApiKey ?

Counter to your ApiKey which is confidential, and that musn't be communicated anyway, your "RadioUid" can be transmited to someone without this precaution.

Where can i find the RadioUid of my radio ?

Each and everyone of your radios gets one RadioUid (if you manage further radios). This unique username can be find on the "Share" Tab on the RMO. (http://rmo.radionomy.com/)

Attachment:
radiouid1.jpg
radiouid1.jpg [ 62.63 KiB | Viewed 38029 times ]


Top
 Profile Send private message  
 
PostPosted: Fri Oct 04, 2013 9:17 am 
Offline
Moderators
User avatar

Joined: Mon Jun 24, 2013 3:35 pm
Posts: 1629
Location: Nancy
Radio 1: http://listen.radionomy.com/BMC
O.S: Windows 8
:: 6-Where can I find my ApiKey ? ::

Your API Key is available on RMO: http://rmo.radionomy.com

First, click on the "Settings" tab:
Attachment:
apikey1.png
apikey1.png [ 71.35 KiB | Viewed 38016 times ]


And then, click on the "Api" tab.
Attachment:
apikey2.png
apikey2.png [ 16.01 KiB | Viewed 38016 times ]


Finally, write your API Key:
Attachment:
apikey3.png
apikey3.png [ 17.5 KiB | Viewed 38016 times ]
]

Warning : Your API Key is unique, please don't share it with other people.


Top
 Profile Send private message  
 
PostPosted: Fri Oct 04, 2013 9:45 am 
Offline
Moderators
User avatar

Joined: Mon Jun 24, 2013 3:35 pm
Posts: 1629
Location: Nancy
Radio 1: http://listen.radionomy.com/BMC
O.S: Windows 8
:: 7- I don't succeed anymore to retrieve information provided by the API, why? ::

It may be most likely your ApiKey has been "blacklisted".
In order to secure stability and API responses for each user, restrictions of use have been included in the process.
That is why the ApiKey is blacklisted as soon as call backs don't fulfil the schema and the constraints due to the amount of calls of each API

Quote:
APIs in numbers:
Everyday Radionomy receives an average of 30,000,000 legal calls on its API, so 1.25 Millions/hour or 350call/seconds.
If illegal calls weren't banished, the server woud receive 180,000,000 calls.


Top
 Profile Send private message  
 
PostPosted: Fri Oct 04, 2013 9:49 am 
Offline
Moderators
User avatar

Joined: Mon Jun 24, 2013 3:35 pm
Posts: 1629
Location: Nancy
Radio 1: http://listen.radionomy.com/BMC
O.S: Windows 8
:: 8-Is my APIKey blacklisted ? ::

When an API is forbidden, when you call it, the API returns as response a "type 301 answer" with redirection towards your own IP address.


Top
 Profile Send private message  
 
PostPosted: Fri Oct 04, 2013 9:53 am 
Offline
Moderators
User avatar

Joined: Mon Jun 24, 2013 3:35 pm
Posts: 1629
Location: Nancy
Radio 1: http://listen.radionomy.com/BMC
O.S: Windows 8
:: 9-How to unlock my ApiKey ? ::

If your ApiKey has been blacklisted, that means that you didn't respect the technical requirements (call limits) specified in the technical documentation.
In order to protect Radionomy servers in order to offer everybody the best service quality, then, your API is blacklisted.

This blacklisting is definitive. It is not possible to unlock and retreive it. So BEFORE posting your scripts on your sites, be sure you respect call limits and that you do a cache memory action of the information on your own server (or host).


Top
 Profile Send private message  
 
Display posts from previous:  Sort by  
Forum locked This topic is locked, you cannot edit posts or make further replies.  [ 12 posts ]  Go to page 1, 2  Next

All times are UTC


Who is online

Users browsing this forum: No registered users and 2 guests


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Jump to:  
Powered by phpBB® Forum Software © phpBB Group