VKFM REST API Quick Start Guide

How to use the Vokoder API

1. Register your application and get an API Key
2. Make Authenticated REST API Requests

Registering An Application

Make sure you are logged in, and then navigate to http://vokoder.fm/developers from there you can enter in the necessary information about your application and obtain an Application API Key.

Why do I need to register?

Registering your application creates a unique API Key, the API Key is used to validate the request you are making with the URI of your application.

This is used to prevent other applications from using the API incorrectly.

The REST API Request Format

The REST API is comprised of four components

• API Version
• Application API Key
• Data Request
• Return Type

Structure: http://api.vokoder.fm/app/[version]/[apikey]/[request].[returnType]

Example: http://api.vokoder.fm/app/0.5/0cas90fj932/search/tracks/money.json

Example query for tracks titled “money” with the results returned in json

API Version

It’s always a number, the first public version of the API is 0.5.

Application API Key

The key generated after you register your application, this is used to tie your application request to a referring URL to ensure the request is coming from your application.

API Request

The data request from the application server

Return Type

Either JSON or XML, we’ll also fully document the error codes so you can gracefully handle error requests.