Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.65 KB

File metadata and controls

33 lines (22 loc) · 1.65 KB

#Introduction

In general, the REST API is optimised for mobile app development.

You can also try:

XMPP-FTW, which is better for realtime web application programming. Refer to their docs for more information.

###Buddycloud HTTP REST API

Welcome to the Buddycloud REST API documentation.

The listed REST API calls give you access to the entire Buddycloud stack. These API calls are designed to make it easy to add rich in-app messaging and social features to your web or mobile app.

###Getting Help We really want this API to be useful to you. If you run into problems please contact us. Documentation fixes and ideas for improvements are always welcome.

These pages are generated using Slate.

##REST API Conventions

###Encoding The REST API uses UTF-8 character encoding. Request headers should include a Content-Type of application/json; charset=utf-8.

###Authentication The REST API uses HTTP basic authentication. The username should also include the user's domain (e.g. username@example.com).

###External Authentication Buddycloud's backend enables you to authenticate your users against your own site by forwarding login requests to your own API. Email us to have this feature enabled for your domain.

###Time Format All timestamps are ISO-8601 formatted.