| |
| Welcome to the Voice of Persia Developer Network |
| The Voice of Persia API allows anyone to build their own Voice of Persia integrated applications for the web, the desktop, mobile devices, or other platforms. We do so by providing a range of API methods and data, which we hope will improve the way Voice of Persia listeners listen and rate songs playing on our radio channels. |
| |
| Why are we doing this? |
| We want to delight our listeners. We are always looking for new ways to improve the service but with a small team we can't do it all. We made these API methods available to the developer community to: |
- Find new ways for our listeners to enjoy our radio channels whether or not they're looking at our website.
- Encourage innovation and new ideas.
|
| |
| Respect the Voice of Persia Brand |
- Third party applications may use the Voice of Persia brand and logo, but not in ways that make customers think that we built, endorse, or sponsor them.
- Clearly associate the Voice of Persia brand with the Voice of Persia service.
- Present the Voice of Persia brand correctly and consistently throughout the product.
- Use the correct language in describing the Voice of Persia service and provide adequate attribution.
|
| |
| Getting Started with Voice of Persia API |
| All API methods are simple HTTP requests and all responses are in JSON objects that either contains the data you requested, or a status indicator. In most cases, you retrieve information from Voice of Persia by having your client make an HTTP GET request for the URL that identifies the specific resource you are requesting. You specify any parameters for the resource using name/value pairs. |
| To start using Voice of Persia API you need a client id to pass as a parameter for each request. To get a client id please contact us with some information about the app you are going to develop. |
| |
| API Methods |
| Voice of Persia is a multi-channel radio. You can fetch the data associated with the channels by fetching |
| http://api.voiceofpersia.com/channels?client_id=CLIENT_ID |
|
| |
| You can fetch the data associated with the current playing song on each channel by fetching |
| http://api.voiceofpersia.com/playing?client_id=CLIENT_ID&channel_id=CHANNEL_ID |
|
| |
| Every song playing on the radio has a unique ID. You can fetch the data associated with a song by fetching |
| http://api.voiceofpersia.com/song?client_id=CLIENT_ID&song_id=SONG_ID |
|
| |
| To like a song you can make the following request |
| http://api.voiceofpersia.com/like?client_id=CLIENT_ID&song_id=SONG_ID |
|
| |
| To dislike a song you can make the following request |
| http://api.voiceofpersia.com/dislike?client_id=CLIENT_ID&song_id=SONG_ID |
|
| |
| Do you need more information? |
| Please feel free to contact us with any question or comment you might have about our API or other services. |
| |
