API

From Noisebridge
(Difference between revisions)
Jump to: navigation, search
(POST /gate/key/[doorcode])
m
(2 intermediate revisions by one user not shown)
Line 15: Line 15:
 
For instance, to open the door using curl:
 
For instance, to open the door using curl:
  
<source lang="bash">    curl -X POST -d open=True http://api.noisebridge.net/gate/</source>
+
  curl -X POST -d open=True http://api.noisebridge.net/gate/
 +
 
 
=== GET /hello/[name] ===
 
=== GET /hello/[name] ===
  
Line 61: Line 62:
 
   Server: WSGIServer/0.1 Python/2.7.3rc2 &lt;  
 
   Server: WSGIServer/0.1 Python/2.7.3rc2 &lt;  
 
   Content-Length: 0 &lt; Content-Type: text/html; charset=UTF-8 &lt;  
 
   Content-Length: 0 &lt; Content-Type: text/html; charset=UTF-8 &lt;  
   Location: http://localhost:8080/gate/key/7895473 &lt;  
+
   Location: http://api.noisebridge.net/gate/key/7895473 &lt;  
  
 
The Location header contains the new doorcode.
 
The Location header contains the new doorcode.
Line 75: Line 76:
 
Just add a function of the form:
 
Just add a function of the form:
  
<source lang="python">
 
 
@api_app.route(&quot;/myurl/&quot;)
 
@api_app.route(&quot;/myurl/&quot;)
 
def myfunc()
 
def myfunc()
 
     do_something_in_the_space()
 
     do_something_in_the_space()
 
     return { 'success' : True, 'OMG IT WORXORRED' }
 
     return { 'success' : True, 'OMG IT WORXORRED' }
</source>
+
 
 
== Deploying your new API ==
 
== Deploying your new API ==
  

Revision as of 23:08, 4 November 2012

Contents

API for Noisebridge

This is a very simple Python WSGI App that provides a RESTful API for fun things in the Noisebridge space.

In the Noisebridge tradition, it's not stable! It will, however try to break in as noisy a way as possible if things change.

Using the API

The API is currently only available within the space. Once we have authorisation running, this will change.

The API is RESTful, and can be called at the URL:

http://api.noisebridge.net/[call]

For instance, to open the door using curl:

 curl -X POST -d open=True http://api.noisebridge.net/gate/

GET /hello/[name]

Returns 'hello [name]'

GET /spaceapi/

Returns Noisebridge status, formatted as per http://hackerspaces.nl/spaceapi/

GET /gate/

Gets interesting stats about the gate. Currently:

    {
    ringing: boolean
    }

Where 'ringing' is true if the gate buzzer is ringing at that moment, or in the last few seconds, as users may push the button for a very short time. The amount of time that this state is cached is totally up to the Gateman daemon that runs to interact with the gate hardware.

POST /gate/

With open=True, opens the door. Returns a 300 error if unsuccessful, and the following additions to the /gate/ stats if successful:

    {
    open : True
    message: string
    }

With key=XXXX, will optionally check the key against the door code list.

Note that this isn't a required field. Currently if you omit the key field, the door will always open. It's intended to optionally allow other apps to offer the same door code authentication that we use for the phone booth entry.

POST /gate/key/[doorcode]

With create=True and an existing, valid doorcode, redirects to a URL of the form /gate/key/[newdoorcode] which gives a valid new doorcode to open the door.

With preferred=[number] you can suggest a doorcode you'd like to use. It's not guaranteed that the preferred option will be returned.

Suppose you have a doorcode 8499146, and you'd like to give a friend a new doorcode. She asks if she can have the number '7895473'

 curl -v -X POST -d create=True -d preferred=7895473 http://api.noisebridge.net/gate/key/8499146

would return something like this:

 POST /gate/key/8499146 HTTP/1.1 >
 HTTP/1.0 303 See Other < 
 Date: Mon, 05 Nov 2012 05:07:29 GMT < 
 Server: WSGIServer/0.1 Python/2.7.3rc2 < 
 Content-Length: 0 < Content-Type: text/html; charset=UTF-8 < 
 Location: http://api.noisebridge.net/gate/key/7895473 < 

The Location header contains the new doorcode.

POST /audio/

With say=[TEXT] will convert the TEXT into speech, and announce it to the space.

Adding to the API

api.py is a Bottle. It should be pretty self explanatory, even if you don't know much Python.

Just add a function of the form:

@api_app.route("/myurl/") def myfunc()

   do_something_in_the_space()
   return { 'success' : True, 'OMG IT WORXORRED' }

Deploying your new API

You'll need sudo powers on minotaur. Check out the code using git:

   git clone git@github.com:noisebridge/noise-api.git

Make your changes, and test them locally using

  python api.py --debug

When you're ready to deploy, change the Debian changelog in debian/changelog , and commit the code to the github repository..

Log onto minotaur, clone the git repository, and make a Debian package. Install it using dpkg -i

  git clone git://github.com/noisebridge/noise-api.git
  cd noise-api
  make package
  sudo dpkg -i ../noisebridge-api_0[whatever the version number is]*.deb
Personal tools