Historic/API - Revision history

Mcint: Mcint moved page API to Historic/API: no longer active project

2024-05-01T07:55:30Z

Mcint moved page API to Historic/API: no longer active project

← Older revision	Revision as of 00:55, 1 May 2024
(No difference)

Danf: modified curl command cf --resolve arg

2013-04-12T02:58:01Z

modified curl command cf --resolve arg

← Older revision		Revision as of 19:58, 11 April 2013
Line 17:		Line 17:
	<source lang="bash">		<source lang="bash">
	curl -X POST -d open=True http://api.noisebridge.net/gate/		curl -X POST -d open=True http://api.noisebridge.net/gate/

			alternatively:

			curl --resolve 'api.noisebridge.net:80:172.30.0.4' -X POST -d open=True http://api.noisebridge.net/gate/
	</source>		</source>
	=== GET /hello/[name] ===		=== GET /hello/[name] ===

ApiBot at 19:03, 7 April 2013

2013-04-07T19:03:53Z

← Older revision		Revision as of 12:03, 7 April 2013
Line 1:		Line 1:
	hello		= 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:

			<source lang="bash">
			curl -X POST -d open=True http://api.noisebridge.net/gate/
			</source>
			=== GET /hello/[name] ===

			Returns 'hello [name]'

			=== GET /spaceapi/ ===

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

			=== GET /gate/ ===

			Gets interesting info about the gate. If you send a "Accept: application/json" header, you'll get a status object, which is currently:

			<pre class="json"> {
			ringing: boolean
			}</pre>
			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.

			If you send a "Accept: text/html" header (as web browsers do), it will return with some useful gate web forms, including one for opening the door with a keycode, and another for getting a new keycode.

			=== POST /gate/ ===

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

			<pre class="json"> {
			open : True
			message: string
			}</pre>
			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.

			''Note: Jake asked me to (temporarily?) disable this, so I have''

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

			Requires comment=[contact email address for new number]

			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'

			<source lang="bash">
			curl -v -X POST -d create=True -d preferred=7895473 \
			-d comment="I'm Dara, my email is new@example.com" http://localhost:8080/gate/key/8499146
			</source>
			would return something like this:

			<pre class="text">
			> POST /gate/key/8499146 HTTP/1.1
			> User-Agent: curl/7.26.0
			> Host: localhost:8080
			> Accept: /
			> Content-Length: 29
			> Content-Type: application/x-www-form-urlencoded
			>
			* upload completely sent off: 29 out of 29 bytes
			* additional stuff not fine transfer.c:1037: 0 0
			* HTTP 1.0, assume close after body
			< HTTP/1.0 303 See Other
			< Date: Mon, 05 Nov 2012 05:07:29 GMT
			< localhost - - [04/Nov/2012 21:07:29] "POST /gate/key/8499146 HTTP/1.1" 303 0
			Server: WSGIServer/0.1 Python/2.7.3rc2
			< Content-Length: 0
			< Content-Type: text/html; charset=UTF-8
			< Location: http://localhost:8080/gate/key/7895473
			<
			* Closing connection #0
			</pre>
			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 [http://bottlepy.org/docs/dev/ Bottle]. It should be pretty self explanatory, even if you don't know much Python.

			Just add a function of the form:

			<source lang="python">
			@api_app.route("/myurl/")
			def myfunc()
			do_something_in_the_space()
			return { 'success' : True, 'OMG IT WORXORRED' }
			</source>
			== Deploying your new API ==

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

			<source lang="bash">
			git clone git@github.com:noisebridge/noise-api.git
			</source>
			Make your changes, and test them locally using

			<source lang="bash">
			python api.py --debug
			</source>
			When you're ready to deploy, change the Debian changelog in debian/changelog (the [http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.man.git.dch.html git-dch] program can help with this), 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

			<source lang="bash">
			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
			</source>

ApiBot at 19:03, 7 April 2013

2013-04-07T19:03:13Z

← Older revision		Revision as of 12:03, 7 April 2013
Line 1:		Line 1:
	~~<open file '<stdin>', mode 'r' at 0x7f1fdf845150>~~		hello

ApiBot: Replaced content with "', mode 'r' at 0x7f1fdf845150>"

2013-04-07T19:01:53Z

Replaced content with "<open file '<stdin>', mode 'r' at 0x7f1fdf845150>"

← Older revision		Revision as of 12:01, 7 April 2013
Line 1:		Line 1:
	~~= API for Noisebridge =~~		<open file '<stdin>', mode 'r' at 0x7f1fdf845150>

	~~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:~~

	<~~source lang="bash">~~
	~~curl -X POST -d~~ open~~=True http://api.noisebridge.net/gate/~~
	<~~/source~~>
	~~=== GET /hello/[name] ===~~

	~~Returns~~ '~~hello [name]'~~

	~~=== GET /spaceapi/ ===~~

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

	~~=== GET /gate/ ===~~

	~~Gets interesting info about the gate. If you send a "Accept: application/json" header, you~~'~~ll get a status object, which is currently:~~

	~~<pre class="json"> {~~
	~~ringing: boolean~~
	~~}</pre>~~
	~~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.

	If you send a "Accept: text/html" header (as web browsers do), it will return with some useful gate web forms, including one for opening the door with a keycode, and another for getting a new keycode.

	~~=== POST /gate/ ===~~

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

	~~<pre class="json"> {~~
	~~open : True~~
	~~message: string~~
	~~}</pre>~~
	~~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.~~

	~~''Note: Jake asked me to (temporarily?) disable this, so I have''~~

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

	~~Requires comment=[contact email address for new number]~~

	~~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'~~

	~~<source lang="bash">~~
	~~curl -v -X POST -d create=True -d preferred=7895473 \~~
	~~-d comment="I'm Dara, my email is new@example.com" http://localhost:8080/gate/key/8499146~~
	~~</source>~~
	~~would return something like this:~~

	~~<pre class="text">~~
	~~> POST /gate/key/8499146 HTTP/1.1~~
	~~> User-Agent: curl/7.26.0~~
	~~> Host: localhost:8080~~
	> Accept: /
	~~> Content-Length: 29~~
	~~> Content-Type: application/x-www-form-urlencoded~~
	~~>~~
	* upload completely sent off: 29 out of 29 bytes
	* additional stuff not fine transfer.c:1037: 0 0
	* HTTP 1.0, assume close after body
	~~< HTTP/1.0 303 See Other~~
	~~< Date: Mon, 05 Nov 2012 05:07:29 GMT~~
	~~< localhost - - [04/Nov/2012 21:07:29] "POST /gate/key/8499146 HTTP/1.1" 303 0~~
	~~Server: WSGIServer/0.1 Python/2.7.3rc2~~
	~~< Content-Length: 0~~
	~~< Content-Type: text/html; charset=UTF-8~~
	~~< Location: http://localhost:8080/gate/key/7895473~~
	~~<~~
	* Closing connection #0
	~~</pre>~~

	~~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 [http://bottlepy.org/docs/dev/ Bottle]. It should be pretty self explanatory, even if you don't know much Python.~~

	~~Just add a function of the form:~~

	~~<source lang="python">~~
	~~@api_app.route("/myurl/")~~
	~~def myfunc()~~
	~~do_something_in_the_space()~~
	~~return { 'success' : True, 'OMG IT WORXORRED' }~~
	~~</source>~~
	~~== Deploying your new API ==~~

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

	~~<source lang="bash">~~
	~~git clone git@github.com:noisebridge/noise-api.git~~
	~~</source>~~
	~~Make your changes, and test them locally using~~

	~~<source lang="bash">~~
	~~python api.py --debug~~
	~~</source>~~
	When you're ready to deploy, change the Debian changelog in debian/changelog (the [http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.man.git.dch.html git-dch] program can help with this), 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~~

	~~<source lang="bash">~~
	~~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~~
	~~</source~~>

Malaclyps at 07:30, 7 April 2013

2013-04-07T07:30:50Z

← Older revision		Revision as of 00:30, 7 April 2013
Line 63:		Line 63:
	<source lang="bash">		<source lang="bash">
	curl -v -X POST -d create=True -d preferred=7895473 \		curl -v -X POST -d create=True -d preferred=7895473 \
	-d comment=~~"~~I'm Dara, my email is new@example.com~~"~~ http://localhost:8080/gate/key/8499146		-d comment="I'm Dara, my email is new@example.com" http://localhost:8080/gate/key/8499146
	</source>		</source>
	would return something like this: ~~```text~~		would return something like this:

	~~<blockquote>POST /gate/key/8499146 HTTP/1.1 User-Agent: curl/7.26.0 Host: localhost:8080 Accept: ''/'' Content-Length: 29 Content-Type: application/x-www-form-urlencoded~~

			<pre class="text">
			> POST /gate/key/8499146 HTTP/1.1
			> User-Agent: curl/7.26.0
			> Host: localhost:8080
			> Accept: /
			> Content-Length: 29
			> Content-Type: application/x-www-form-urlencoded
			>
	* upload completely sent off: 29 out of 29 bytes		* upload completely sent off: 29 out of 29 bytes
	* additional stuff not fine transfer.c:1037: 0 0		* additional stuff not fine transfer.c:1037: 0 0
	* HTTP 1.0, assume close after body < HTTP/1.0 303 See Other < Date: Mon, 05 Nov 2012 05:07:29 GMT < localhost - - [04/Nov/2012 21:07:29] "POST /gate/key/8499146 HTTP/1.1" 303 0 Server: WSGIServer/0.1 Python/2.7.3rc2 < Content-Length: 0 < Content-Type: text/html; charset=UTF-8 < Location: http://localhost:8080/gate/key/7895473 <		* HTTP 1.0, assume close after body
			< HTTP/1.0 303 See Other
			< Date: Mon, 05 Nov 2012 05:07:29 GMT
			< localhost - - [04/Nov/2012 21:07:29] "POST /gate/key/8499146 HTTP/1.1" 303 0
			Server: WSGIServer/0.1 Python/2.7.3rc2
			< Content-Length: 0
			< Content-Type: text/html; charset=UTF-8
			< Location: http://localhost:8080/gate/key/7895473
			<
	* Closing connection #0		* Closing connection #0
	</~~blockquote~~>		</pre>
	~~<pre>~~
	The Location header contains the new doorcode.		The Location header contains the new doorcode.

			=== POST /audio/ ===
	~~###~~ POST /audio/

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

	Adding to the API		== Adding to the API ==
	~~-----------------~~

	api.py is a [~~Bottle](~~http://bottlepy.org/docs/dev/). It should be pretty self		api.py is a [http://bottlepy.org/docs/dev/ Bottle]. It should be pretty self explanatory, even if you don't know much Python.
	explanatory, even if you don't know much Python.

	Just add a function of the form:		Just add a function of the form:
	~~</pre>~~
	~~@api_app.route("/myurl/") def myfunc() do_something_in_the_space() return { 'success' : True, 'OMG IT WORXORRED' }~~

	<~~pre~~>		<source lang="python">
	Deploying your new API		@api_app.route("/myurl/")
	~~----------------------~~		def myfunc()
			do_something_in_the_space()
			return { 'success' : True, 'OMG IT WORXORRED' }
			</source>
			== Deploying your new API ==

	You'll need sudo powers on minotaur. Check out the code using git:		You'll need sudo powers on minotaur. Check out the code using git:
	~~</pre>~~
	~~<pre>git clone git@github.com:noisebridge/noise-api.git</pre>~~
	~~<pre>~~
	~~Make your changes, and test them locally using~~
	~~</pre>~~
	~~python api.py --debug~~

	<~~pre~~>		<source lang="bash">
	When you're ready to deploy, change the Debian changelog in debian/changelog		git clone git@github.com:noisebridge/noise-api.git
	(the [~~git-dch](~~http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.man.git.dch.html)		</source>
	program can help with this), and commit the code to the github repository..		Make your changes, and test them locally using

			<source lang="bash">
			python api.py --debug
			</source>
			When you're ready to deploy, change the Debian changelog in debian/changelog (the [http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.man.git.dch.html git-dch] program can help with this), 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		Log onto minotaur, clone the git repository, and make a Debian package. Install it using dpkg -i
	~~</pre>~~
	~~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~~

	~~```~~		<source lang="bash">
			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
			</source>

Malaclyps at 07:27, 7 April 2013

2013-04-07T07:27:09Z

← Older revision		Revision as of 00:27, 7 April 2013
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>		<source lang="bash">
			curl -X POST -d open=True http://api.noisebridge.net/gate/
			</source>
	=== GET /hello/[name] ===		=== GET /hello/[name] ===

Line 59:		Line 61:
	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'		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'

	<source lang="bash">curl -v -X POST -d create=True -d preferred=7895473 -d comment="I'm Dara, my email is ~~newperson~~@example.com" http://localhost:8080/gate/key/8499146</source>		<source lang="bash">
	would return something like this: <tt>~~>~~ POST /gate/key/8499146 HTTP/1.1 ~~>~~ User-Agent: curl/7.26.0 ~~>~~ Host: localhost:8080 ~~>~~ Accept: / > Content-Length: 29 ~~>~~ Content-Type: application/x-www-form-urlencoded > * upload completely sent off: 29 out of 29 bytes * additional stuff not fine transfer.c:1037: 0 0 * HTTP 1.0, assume close after body < HTTP/1.0 303 See Other < Date: Mon, 05 Nov 2012 05:07:29 GMT < localhost - - [04/Nov/2012 21:07:29] "POST /gate/key/8499146 HTTP/1.1" 303 0 Server: WSGIServer/0.1 Python/2.7.3rc2 < Content-Length: 0 < Content-Type: text/html; charset=UTF-8 < Location: http://localhost:8080/gate/key/7895473 < * Closing connection #0</tt>		curl -v -X POST -d create=True -d preferred=7895473 \
			-d comment="I'm Dara, my email is new@example.com" http://localhost:8080/gate/key/8499146
			</source>
			would return something like this: ```text

			<blockquote>POST /gate/key/8499146 HTTP/1.1 User-Agent: curl/7.26.0 Host: localhost:8080 Accept: ''/'' Content-Length: 29 Content-Type: application/x-www-form-urlencoded

			* upload completely sent off: 29 out of 29 bytes
			* additional stuff not fine transfer.c:1037: 0 0
			* HTTP 1.0, assume close after body < HTTP/1.0 303 See Other < Date: Mon, 05 Nov 2012 05:07:29 GMT < localhost - - [04/Nov/2012 21:07:29] "POST /gate/key/8499146 HTTP/1.1" 303 0 Server: WSGIServer/0.1 Python/2.7.3rc2 < Content-Length: 0 < Content-Type: text/html; charset=UTF-8 < Location: http://localhost:8080/gate/key/7895473 <
			* Closing connection #0
			</blockquote>
			<pre>
	The Location header contains the new doorcode.		The Location header contains the new doorcode.

	~~===~~ POST /audio/ ~~===~~
			### POST /audio/

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

	== Adding to the API ==		Adding to the API
			-----------------

	api.py is a [http://bottlepy.org/docs/dev/ ~~Bottle]~~. It should be pretty self explanatory, even if you don't know much Python.		api.py is a [Bottle](http://bottlepy.org/docs/dev/). It should be pretty self
			explanatory, even if you don't know much Python.

	Just add a function of the form:		Just add a function of the form:
			</pre>
			@api_app.route("/myurl/") def myfunc() do_something_in_the_space() return { 'success' : True, 'OMG IT WORXORRED' }

	<~~syntaxhighlight lang="python"~~>		<pre>
	~~@api_app.route("/myurl/")~~		Deploying your new API
	~~def myfunc()~~		----------------------
	~~do_something_in_the_space()~~
	~~return { 'success' : True, 'OMG IT WORXORRED' }~~
	~~</syntaxhighlight>~~
	== Deploying your new API ==

	You'll need sudo powers on minotaur. Check out the code using git:		You'll need sudo powers on minotaur. Check out the code using git:
			</pre>
			<pre>git clone git@github.com:noisebridge/noise-api.git</pre>
			<pre>
			Make your changes, and test them locally using
			</pre>
			python api.py --debug

	<~~source lang="bash"> git clone git@github.com:noisebridge/noise-api.git</source>~~		<pre>
	~~Make your changes, and test them locally using~~		When you're ready to deploy, change the Debian changelog in debian/changelog
			(the [git-dch](http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.man.git.dch.html)
	~~<source lang="bash"> python api.py --debug</source~~>		program can help with this), and commit the code to the github repository..
	When you're ready to deploy, change the Debian changelog in debian/changelog (the [http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.man.git.dch.html ~~git-dch]~~ program can help with this), 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		Log onto minotaur, clone the git repository, and make a Debian package. Install it using dpkg -i
			</pre>
			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

	~~<source lang="bash"> 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~~
	~~</source>~~

Malaclyps at 07:20, 7 April 2013

2013-04-07T07:20:44Z

← Older revision		Revision as of 00:20, 7 April 2013
Line 74:		Line 74:
	Just add a function of the form:		Just add a function of the form:

	<~~source~~ lang="python">@api_app.route("/myurl/")		<syntaxhighlight lang="python">
			@api_app.route("/myurl/")
	def myfunc()		def myfunc()
	do_something_in_the_space()		do_something_in_the_space()
	return { 'success' : True, 'OMG IT WORXORRED' }</~~source~~>		return { 'success' : True, 'OMG IT WORXORRED' }
			</syntaxhighlight>
	== Deploying your new API ==		== Deploying your new API ==

Malaclyps at 07:17, 7 April 2013

2013-04-07T07:17:54Z

← Older revision		Revision as of 00:17, 7 April 2013
Line 15:		Line 15:
	For instance, to open the door using curl:		For instance, to open the door using curl:

	curl -X POST -d open=True http://api.noisebridge.net/gate/</source>		<source lang="bash"> curl -X POST -d open=True http://api.noisebridge.net/gate/</source>
	=== GET /hello/[name] ===		=== GET /hello/[name] ===

Line 26:		Line 26:
	=== GET /gate/ ===		=== GET /gate/ ===

	Gets interesting ~~stats~~ about the gate. ~~Currently~~:		Gets interesting info about the gate. If you send a "Accept: application/json" header, you'll get a status object, which is currently:

	<pre class="json"> {		<pre class="json"> {
Line 32:		Line 32:
	}</pre>		}</pre>
	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.		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.

			If you send a "Accept: text/html" header (as web browsers do), it will return with some useful gate web forms, including one for opening the door with a keycode, and another for getting a new keycode.

	=== POST /gate/ ===		=== POST /gate/ ===
Line 48:		Line 50:

	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 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.

			''Note: Jake asked me to (temporarily?) disable this, so I have''

	With preferred=[number] you can suggest a doorcode you'd like to use. It's not guaranteed that the preferred option will be returned.		With preferred=[number] you can suggest a doorcode you'd like to use. It's not guaranteed that the preferred option will be returned.
Line 55:		Line 59:
	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'		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'

	<~~pre~~ lang="bash">curl -v -X POST -d create=True -d preferred=7895473 -d comment="I'm Dara, my email is newperson@example.com" http://localhost:8080/gate/key/8499146</~~pre~~>		<source lang="bash">curl -v -X POST -d create=True -d preferred=7895473 -d comment="I'm Dara, my email is newperson@example.com" http://localhost:8080/gate/key/8499146</source>
	would return something like this:		would return something like this: <tt>> POST /gate/key/8499146 HTTP/1.1 > User-Agent: curl/7.26.0 > Host: localhost:8080 > Accept: / > Content-Length: 29 > Content-Type: application/x-www-form-urlencoded > * upload completely sent off: 29 out of 29 bytes * additional stuff not fine transfer.c:1037: 0 0 * HTTP 1.0, assume close after body < HTTP/1.0 303 See Other < Date: Mon, 05 Nov 2012 05:07:29 GMT < localhost - - [04/Nov/2012 21:07:29] "POST /gate/key/8499146 HTTP/1.1" 303 0 Server: WSGIServer/0.1 Python/2.7.3rc2 < Content-Length: 0 < Content-Type: text/html; charset=UTF-8 < Location: http://localhost:8080/gate/key/7895473 < * Closing connection #0</tt>
	<~~pre~~>> POST /gate/key/8499146 HTTP/1.1
	> User-Agent: curl/7.26.0
	> Host: localhost:8080
	> Accept: /
	> Content-Length: 29
	> Content-Type: application/x-www-form-urlencoded
	> * upload completely sent off: 29 out of 29 bytes * additional stuff not fine transfer.c:1037: 0 0 * HTTP 1.0, assume close after body
	< HTTP/1.0 303 See Other
	< Date: Mon, 05 Nov 2012 05:07:29 GMT
	< localhost - - [04/Nov/2012 21:07:29] "POST /gate/key/8499146 HTTP/1.1" 303 0 Server: WSGIServer/0.1 Python/2.7.3rc2
	< Content-Length: 0
	< Content-Type: text/html; charset=UTF-8
	< Location: http://localhost:8080/gate/key/7895473
	< * Closing connection #0</~~pre~~>

	The Location header contains the new doorcode.		The Location header contains the new doorcode.
Line 84:		Line 74:
	Just add a function of the form:		Just add a function of the form:

	<~~pre~~ lang="python">@api_app.route("/myurl/")		<source lang="python">@api_app.route("/myurl/")
	def myfunc()		def myfunc()
	do_something_in_the_space()		do_something_in_the_space()
	return { 'success' : True, 'OMG IT WORXORRED' }</~~pre~~>		return { 'success' : True, 'OMG IT WORXORRED' }</source>
	== Deploying your new API ==		== Deploying your new API ==

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

	<~~pre~~ lang="bash"> git clone git@github.com:noisebridge/noise-api.git</~~pre~~>		<source lang="bash"> git clone git@github.com:noisebridge/noise-api.git</source>
	Make your changes, and test them locally using		Make your changes, and test them locally using

	<~~pre~~ lang="bash"> python api.py --debug</~~pre~~>		<source lang="bash"> python api.py --debug</source>
	When you're ready to deploy, change the Debian changelog in debian/changelog (the [http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.man.git.dch.html git-dch] program can help with this), and commit the code to the github repository..		When you're ready to deploy, change the Debian changelog in debian/changelog (the [http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.man.git.dch.html git-dch] program can help with this), 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		Log onto minotaur, clone the git repository, and make a Debian package. Install it using dpkg -i

	<~~pre~~ lang="bash"> git clone git://github.com/noisebridge/noise-api.git		<source lang="bash"> git clone git://github.com/noisebridge/noise-api.git
	cd noise-api		cd noise-api
	make package		make package
	sudo dpkg -i ../noisebridge-api_0[whatever the version number is]*.deb		sudo dpkg -i ../noisebridge-api_0[whatever the version number is]*.deb
	</~~pre~~>		</source>

Malaclyps at 04:07, 2 January 2013

2013-01-02T04:07:14Z

← Older revision		Revision as of 21:07, 1 January 2013
Line 15:		Line 15:
	For instance, to open the door using curl:		For instance, to open the door using curl:

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

	=== GET /hello/[name] ===		=== GET /hello/[name] ===

Line 51:		Line 50:

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

			Requires comment=[contact email address for new number]

	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'		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		<pre lang="bash">curl -v -X POST -d create=True -d preferred=7895473 -d comment="I'm Dara, my email is newperson@example.com" http://localhost:8080/gate/key/8499146</pre>

	would return something like this:		would return something like this:
	POST /gate/key/8499146 HTTP/1.1 >		<pre>> POST /gate/key/8499146 HTTP/1.1
	HTTP/1.0 303 See Other <		> User-Agent: curl/7.26.0
	Date: Mon, 05 Nov 2012 05:07:29 GMT <		> Host: localhost:8080
	Server: WSGIServer/0.1 Python/2.7.3rc2 <		> Accept: /
	Content-Length: 0 < Content-Type: text/html; charset=UTF-8 <		> Content-Length: 29
	Location: http://~~api.noisebridge.net~~/gate/key/7895473 <		> Content-Type: application/x-www-form-urlencoded
			> * upload completely sent off: 29 out of 29 bytes * additional stuff not fine transfer.c:1037: 0 0 * HTTP 1.0, assume close after body
			< HTTP/1.0 303 See Other
			< Date: Mon, 05 Nov 2012 05:07:29 GMT
			< localhost - - [04/Nov/2012 21:07:29] "POST /gate/key/8499146 HTTP/1.1" 303 0 Server: WSGIServer/0.1 Python/2.7.3rc2
			< Content-Length: 0
			< Content-Type: text/html; charset=UTF-8
			< Location: http://localhost:8080/gate/key/7895473
			< * Closing connection #0</pre>

	The Location header contains the new doorcode.		The Location header contains the new doorcode.
Line 76:		Line 84:
	Just add a function of the form:		Just add a function of the form:

	@api_app.route("/myurl/")		<pre lang="python">@api_app.route("/myurl/")
	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' }</pre>

	== Deploying your new API ==		== Deploying your new API ==

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

	git clone git@github.com:noisebridge/noise-api.git		<pre lang="bash"> git clone git@github.com:noisebridge/noise-api.git</pre>

	Make your changes, and test them locally using		Make your changes, and test them locally using

	python api.py --debug		<pre lang="bash"> python api.py --debug</pre>
			When you're ready to deploy, change the Debian changelog in debian/changelog (the [http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.man.git.dch.html git-dch] program can help with this), and commit the code to the github repository..
	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		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		<pre lang="bash"> git clone git://github.com/noisebridge/noise-api.git
	cd noise-api		cd noise-api
	make package		make package
	sudo dpkg -i ../noisebridge-api_0[whatever the version number is]*.deb		sudo dpkg -i ../noisebridge-api_0[whatever the version number is]*.deb
			</pre>