The Buddy JavaScript SDK helps you get up and running in seconds.
For the most part, the Buddy JavaScript SDK takes care of all the housekeeping of making requests against the Buddy REST API:
- Building and formatting requests
- Managing authentication
- Parsing responses
- Loading and saving credentials
With that handled, all you have to do is initialize the SDK and start making some calls!
To get started with the Buddy Platform SDK, please reference the Getting Started series of documents at buddyplatform.com/docs. You will need an application ID and key before you can use the SDK. The Getting Started documents will walk you through obtaining everything you need and show you where to find the SDK for your platform.
Application IDs and keys are obtained at the Buddy Developer Dashboard at buddyplatform.com.
Full documentation for Buddy's services are available at buddyplatform.com/docs.
-
Clone the repo to your desktop
-
Move the buddy.js file to a convenient location within your project
-
Create or open your HTML project
-
Add the following lines to your
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script> <script src="buddy.js"></script><HEAD>...</HEAD>tags or at the end of<BODY>before any other JavaScript
Visit the Buddy Dashboard to obtain your application ID and key.
Buddy.init('[your app id]', '[your app key]');
You may see the word "Undefined" appear in your console here. This is not an error, it is simply JavaScript's way of notifying you that the Buddy.init call does not return a value.
The Buddy JavaScript SDK handles user creation and login.
// Only username and password are required
Buddy.createUser({
username: 'test',
password: 'password',
firstName: 'Test',
lastName: 'User',
email: 'test@test.com',
dob: '4/23/1980'
}, [callback]);
// All functions from here on out accept callbacks
// Callbacks are optional in the JavaScript SDK as indicated by the [ ]
Buddy.loginUser('test', 'password', [callback]);
Buddy.logoutUser();
Each SDK provides wrappers that make REST calls to Buddy.
In this example we'll create a checkin. Take a look at the create checkin REST documentation then:
// POST to Checkins
// Location is required
Buddy.post('/checkins', {location: '34.052, -118.243', description: 'Somewhere in LA'}, [callback]);
We now can call GET to search for the checkin we just created!
// GET a checkin by ID
var checkinId;
Buddy.get('/checkins/' + checkinId, [callback]);
Each remaining REST verb is available through the Buddy SDK using the same pattern as the POST and GET examples.
Buddy offers support for binary files. The JavaScript SDK works with files through our REST interface similarly to other API calls.
Note: Responses for files deviate from the standard Buddy response templates. See the Buddy Platform documentation for more information.
Here we demonstrate uploading a picture. For all binary files (e.g. blobs and videos), the pattern is the same, but with a different path and different parameters. For full documentation see our Media and Files documentation page.
// This example assumes both of the following HTML elements exist:
// <input type="file" id="file" name="file" />
// <input id="uploadButton" type="button" value="Upload" />
$('#uploadButton').click(function() {
var inputFile = $('#file')[0];
var myImage = inputFile.files[0];
Buddy.post('/pictures', {data: myImage});
});
Due to browser limitations the JavaScript SDK does not support direct file downloads.
We'd love to have your help making the Buddy SDK as good as it can be!
To submit a change to the Buddy SDK please do the following:
-
Create your own fork of the Buddy SDK
-
Make the change to your fork
-
Before creating your pull request, please sync your repository to the current state of the parent repository:
git pull origin master -
Commit your changes, then submit a pull request for just that commit
This should have given you the basics of how to work with the Buddy JavaScript SDK. If you have further questions or are stuck, send an email to support@buddy.com.