Numly API

 

Numly has new RESTful APIs for checking Numly Numbers and generating new ESNs associated with works. You may use JSON as the extension rather than XML if you would prefer a JavaScript formatted response.

Inquiring

Checking Numly Numbers is as simple as a Method GET request to Numly with the ESN appended to the URL like the following:

http://numly.com/verify/27200-060121-189140-97.xml

Returns:


<number>
<author>Chris Matthieu</author>
<copyright/>
<created-at type="datetime">2010-09-06T18:37:11Z</created-at>
<docdesc>Numly website</docdesc>
<docid>CB1EC008-18F7-49CC-9B4A-2EEE6C54B5A9</docid>
<docly type="boolean" nil="true"/>
<docname>Numly.com</docname>
<ecounter type="integer">14266</ecounter>
<esbn>2720006012118914097</esbn>
<fileext/>
<id type="integer">87</id>
<jamly type="boolean" nil="true"/>
<licemail>chris@numly.com</licemail>
<licensee>Chris Matthieu</licensee>
<md5/>
<parentesbn/>
<privateflag type="boolean">false</privateflag>
<publisher>Chris Matthieu</publisher>
<tagly type="boolean" nil="true"/>
<timestamp type="datetime">2006-01-21T08:38:21Z</timestamp>
<updated-at type="datetime">2010-09-06T18:37:11Z</updated-at>
<url>http://numly.com</url>
<user-id type="integer">1</user-id>
</number>

Publishing

Registering a digital asset with Numly with an ESN returned as a response can be accomplished as a Method POST to Numly with the following details:

curl -d "number[docname]=test&number[docdesc]=this+is+a+test&number[author]=chris+matthieu&number[publisher]=chris+matthieu&number[licensee]=chris+matthieu&number[licemail]=chris@numly.com&number[url]=http://mysite.com" http://username:password@numly.com/numbers.xml

Returns:


<?xml version="1.0" encoding="UTF-8"?>
<number>
<author>chris matthieu</author>
<copyright nil="true"></copyright>
<created-at type="datetime">2010-09-11T23:10:31Z</created-at>
<docdesc>this is a test</docdesc>
<docid nil="true"></docid>
<docly type="boolean" nil="true"></docly>
<docname>test</docname>
<ecounter type="integer" nil="true"></ecounter>
<esbn>9007510091187560683</esbn>
<fileext nil="true"></fileext>
<id type="integer">11146</id>
<jamly type="boolean" nil="true"></jamly>
<licemail>chris@numly.com</licemail>
<licensee>chris matthieu</licensee>
<md5 nil="true"></md5>
<parentesbn nil="true"></parentesbn>
<privateflag type="boolean" nil="true"></privateflag>
<publisher>chris matthieu</publisher>
<tagly type="boolean" nil="true"></tagly>
<timestamp type="datetime">2010-09-11T23:10:31Z</timestamp>
<updated-at type="datetime">2010-09-11T23:10:31Z</updated-at>
<url>http://mysite.com</url>
<user-id type="integer">1</user-id>
</number>