Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 928975a8ac
Fetching contributors…

Cannot retrieve contributors at this time

136 lines (110 sloc) 4.8 kb
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html lang="en">
<head>
<meta name="generator" content=
"HTML Tidy for Linux (vers 25 March 2009), see www.w3.org">
<title>BUGswarm Developers</title>
<link rel="stylesheet" href="bootstrap/bootstrap.css" type=
"text/css">
<link rel="stylesheet" href="css/this.css" type="text/css">
<link rel="stylesheet" href=
"js/google-code-prettify/prettify.css" type="text/css">
<script src="http://code.jquery.com/jquery-1.5.2.js" type=
"text/javascript">
</script>
<script src="js/google-code-prettify/prettify.js" type=
"text/javascript">
</script>
<script src="js/application.js" type="text/javascript">
</script>
<script src="js/google-analytics.js" type="text/javascript">
</script>
</head>
<body>
<!-- NAVIGATION-->
<div class="topbar">
<div class="topbar-inner">
<div class="container">
<h3><a id="banner" href="index.html" name=
"banner"><img src="images/bs_logo.png"></a></h3>
<ul class="nav">
<li class="dropdown nav-dropdown">
<a href="documentation.html" class=
"dropdown-toggle">Documentation</a>
<ul class="dropdown-menu">
<li><a href=
"configuration_api.html">Configuration</a></li>
<li><a href=
"participation_api.html">Participation</a></li>
</ul>
</li>
<li><a href="tools.html">Tools</a></li>
<li><a href="libraries.html">Libraries</a></li>
<li><a href="tutorial.html">Tutorial</a></li>
<li><a href="applications.html">Applications</a></li>
<li><a href="hardware.html">Hardware</a></li>
<li><a href="contact.html">Contact</a></li>
</ul>
</div>
</div>
</div><!-- CONTENT-->
<div class="container">
<!-- Path-->
<div class="page-header">
<a href="index.html">Home</a> &rarr; Documentation
</div><!-- Header-->
<h1>Documentation</h1>
<div class="page-header">
<h2>API</h2>
<p>The BUGswarm API can be broken down into two primary
actions, configuration and participation. Configuration
includes the creation, updating, and destruction of swarms
and their resources in addition to inviting other users'
resources into your swarms and accepting or rejecting pending
invitations. Participation includes producing and consuming
data within one or many swarms.</p><!-- Descriptions-->
<div class="row">
<div class="span8">
<h3><a href="configuration_api.html">Configuration</a>
<small>Establish swarms, resources, and
invitations</small></h3>
<p>BUGswarm uses a RESTful (Representational State
Transfer) API to configure swarms and their resources.
Use it to create and destroy swarms and resources, add
and remove resources to and from swarms, and generate API
keys. In addition to these methods, the Configuration API
also takes care of the social aspect of BUGswarm, sending
invitations to other users' resources to join your swarms
as well as accepting and rejecting pending invitations.
To make development easier, the Configuration API has
been wrapped up in <a href=
"http://github.com/buglabs/bugswarm-tools">BUGswarm
Tools</a>, a set of python scripts used to make the
development process simple and easy.</p>
</div>
<div class="span8">
<h3><a href="participation_api.html">Participation</a>
<small>Produce and consume data</small></h3>
<p>BUGswarm makes use of an HTTP streaming API to allow
resources to connect to and participate in the swarms
they are members of. Because the Participation API uses
streaming, after connecting a resource to a swarm, the
connection remains open while bidirectional HTTP requests
are processed. To make development easier, the
Participation API has also been wrapped up in <a href=
"http://github.com/buglabs/bugswarm-tools">BUGswarm
Tools</a> . Use the `consume.py` and `produce.py` scripts
for use the Participation API from the command line.</p>
</div>
</div>
<div class="page-header"></div><!-- Tools and Libraries-->
<h2>Tools and Libraries</h2>
<p>In order to make the BUGswarm development process as easy
and friendly as possible, we have developed a set of tools
and libraries to help you get started even faster. Visit the
<a href="tools.html">Tools</a> and <a href=
"libraries.html">Libraries</a> pages to learn more.</p>
</div>
</div>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.