Developer API Documentation

Note: Authentication means typical HTTP authentication, i.e.: http://username:password@iradeo.com/api/players/list

/api/sign_up

Creates a new iRadeo account.

URL

http://www.iradeo.com/api/sign_up

Supported formats

json

Supported request methods

POST

Requires authentication

false

Parameters

  • username

    The username you would like to register.

  • password

    A strong password of six characters or more.

  • email

    A valid email address.

  • api_key

    Your API key.

Returns

  • Success {"status":"ok","user_id":"…"}
  • Failure {"status":"error","error":"…"}

/api/players/list

Return a list of all players for an account. Includes information such as the player ID and any configuration settings.

URL

http://www.iradeo.com/api/players/list

Supported formats

json

Supported request methods

GET

Requires authentication

true

Parameters

  • api_key

    Your API key.

Returns

  • Success {"status":"ok","players":[…]}

/api/audio/list

Return a list of all audio for a particular player. Includes information such as the audio ID, filename, title, and artist.

URL

http://www.iradeo.com/api/audio/list

Supported formats

json

Supported request methods

GET

Requires authentication

true

Parameters

  • player

    Player for which you would like to list audio. Player IDs can be obtained with /api/players/list.

  • api_key

    Your API key.

Returns

  • Success {"status":"ok","player":"…","audio":[…]}
  • Failure {"status":"error","error":"no_such_player"}

/api/audio/upload

Upload audio for a particular player.

URL

http://www.iradeo.com/api/audio/upload

Supported formats

json

Supported request methods

POST

Requires authentication

true

Parameters

  • player

    Player for which you would like to upload audio. Player IDs can be obtained with /api/players/list.

  • file

    File you are uploading. This means that the page should be POSTed as multipart/form-data.

  • title

    The title to be displayed when this audio file is playing in the player.

  • artist

    The artist to be displayed when this audio file is playing in the player.

  • api_key

    Your API key.

Returns

  • Success {"status":"ok","audio_id":"…"}
  • Failure {"status":"error","error":"…"}

/api/audio/delete

Delete audio from a particular player.

URL

http://www.iradeo.com/api/audio/delete

Supported formats

json

Supported request methods

POST

Requires authentication

true

Parameters

  • audio

    ID of the audio file to delete. Audio IDs can be obtained with /api/audio/list.

  • api_key

    Your API key.

Returns

  • Success {"status":"ok"}
  • Failure {"status":"error","error":"…"}