Swarm API Documentation


Introduction

Swarmforce exposes most of the functionality of swarms and swarmkarma via an Application Programming Interface (API). This document is a reference for that functionality, and aims to serve as a reference for developers building tools that talk to swarms.

 

Methods

 

 

Concepts

 

Authentication

Some swarm API methods require authentication and some do not.  All responses are relative to the context of the authenticating user.  For example, an attempt to add information to a protected swarm (private swarm) from a user who is not a member of that swarm will fail. See individual method documentation for more information

 

 

RESTful Resources

The Swarm API attempts to conform to the design principles of Representational State Transfer (REST). You’ll find that you can simply change the file extension on most any request to get results in the format of your choice. This document notes which formats are available for each method.

 

Swarmforce presently supports the following data formats: JSON