Braineos API Now Available

A Braineos JSON API is now available! Now you can build your own games and apps which use Braineos flashcards. There are three open API methods: Deck Search, User Decks and View Deck. Continue reading to find out how to use them.

 

Deck Search

Description: Search for all the flashcard decks with ‘searchTerm’ in the title or tag

Format: http://www.braineos.com/api/v1/search/{searchTerm}/{max}

Example: http://www.braineos.com/api/v1/search/spanish/10

Sample Response:

{ “items”:[
{
"deckVotes":3,
"displayName":"Spanish Vocabulary - Multiples of Ten",
"id":"1187015",
"name":"Spanish Vocabulary - Multiples of Ten"
},
{
"deckVotes":2,
"displayName":"Ricitos de Oro Episodes 1, 2, 3.",
"id":"938016",
"name":"Ricitos de Oro Episodes 1, 2, 3."
}
]}

 

User Decks

Description: Retrieve all the decks created by the specified user

Format: http://www.braineos.com/api/v1/users/{userName}/decks/{max}

Example: http://www.braineos.com/api/v1/users/braineos/decks/10

Sample Response:

{“items”:[
{
"deckVotes":0,
"displayName":"French Numbers 1 to 10",
"id":"3712120",
"name":"French Numbers 1 to 10"
},
{
"deckVotes":0,
"displayName":"Spanish regular verbs -ir (present)",
"id":"412019",
"name":"Spanish regular verbs -ir (present)"
}
]}

 

View Deck

Description: Retrieve the contents of the specified deck

Format: http://www.braineos.com/api/v1/decks/{deckId}

Example: http://www.braineos.com/api/v1/decks/3712120

Sample Response:

{“items”:[
{
"definition":"huit",
"term":"eight"
},
{
"definition":"neuf",
"term":"nine"
},
{
"definition":"un",
"term":"one"
},
{
"definition":"cinq",
"term":"five"
},
{
"definition":"deux",
"term":"two"
},
{
"definition":"six",
"term":"six"
},
{
"definition":"quatre",
"term":"four"
},
{
"definition":"dix",
"term":"ten"
},
{
"definition":"trois",
"term":"three"
},
{
"definition":"sept",
"term":"seven"
}
]}

These methods are open, no authentication is required. However, we reserve the right to rate limit requests if there is heavy usage.

Got an idea for a new flashcard game? Let us know in the comments, or on our GetSatisfaction forum.