Skip to content
Paul Bird edited this page Apr 1, 2015 · 2 revisions

Introduction

Overview

The Braid Mangement API the one of two apis written for braid.io. They are both HTTP REST apis. In the future if this is successful it isn't known how many different people might be using it. So to keep things lean I decided to split the apis into their own servers sharing one database.

This mangement api reads and writes to the database which is run on MongoDB. The other server known as the delivery api will just expose api endpoint requests where people can grab, sort and collect the data from the database through api endpoints.

What is Braid.io

Braid.io is an attempt to unify and modify the content that we have stored on lots of different services. Most services expose apis nowadays that we can use to pull into other applications or simple statics sites. What braid does is take data from a specified service and allow you to apply additional data to give it features that the service you use doesn't provide; I've called this concept a modifier. To help you understand here is a couple of use-cases.

Use Cases

Youtube

Youtube is great, it allows you to upload videos and they host it all for you. They also have an api so you can use it to make applications powered by youtube. One of the flaws that Youtube has is that it doesn't have site specific categories, and even though youtube does have categories they are pre-determined and it only improves searching on their website. What if you could add categories to the entries that are pulled in from a specific youtube channel or playlist and then have the ability to sort the entries by them. This could be done using a collection modifier.

Dribbble / Behance

Lots of designers post work up onto dribbble but they don't provide a way of categorising or even a way to add an extensive write up of how the person made their work. Using a modifier, if its a modifier that allowed you to add a set amount of content and then later you could request the original dribbble post plus your own content in that modifier then it would be easy to suddenly make a portfolio with ease.