CrowdSifter

GET https://acme.crowdsifter.com/api/imgs/0.xml?url=http%3A%2F%2Ffacestat.com%2Ffaces%2Fimage%2F400.jpg

<?xml version="1.0" encoding="UTF-8"?>
<image>
     <created-at type="datetime">2008-09-11T01:26:56Z</created-at>
     <id type="integer">382</id>
     <url>http://facestat.com/faces/image/400.jpg</url>
     <rating>0.00</rating>
</image>

POST https://acme.crowdsifter.com/api/imgs/0.xml
url=http%3A%2F%2Ffacestat.com%2Ffaces%2Fimage%2F400.jpg

{"success": "Image queued for processing"}

One easy way to start playing with the API is by downloading our convenient ruby class. Below are a few examples of using it.

$ sudo gem install httparty
$ irb 
>> require 'crowdsifter.rb'
=> true
>> c = CrowdSifter.new('acme', 0, 'YOU_MUST_CREATE_AN_ACCOUNT_AND_ADD_A_SITE_TO_GET_A_TOKEN')
=> #<CrowdSifter:0x112f754 @token="YOU_MUST_CREATE_AN_ACCOUNT_AND_ADD_A_SITE_TO_GET_A_TOKEN", @id=0, @company="acme">
>> c.moderate("http://acme.crowdsifter.com/demosome_image.jpg")
=> {"success"=>"Image queued for processing"}
>> c.img(:url => "http://acme.crowdsifter.com/demosome_image.jpg")
=> {"image"=>{"rating"=>nil, "url"=>"http://acme.crowdsifter.com/demosome_image.jpg",
   "id"=>12693, "created_at"=>Wed Sep 08 17:35:16 +0000 2010}}
  

Setting up webhooks is extremely simple. Goto your account page and enter a url for CrowdSifter to post to. CrowdSifter will post to your url twice during the lifecycle of an image. Once after the image has been created (an image is put into a queue for processing when it is added), and once after the image has completed moderation. If the rating is null, it is a post create hook. Post create hooks can also inform you images that failed to be created for various reasons. You can test the postbacks by using the "Test webhook" link on the account page.

Here is an example successful webhook post create request:

{
   rating => null,
   id => 1,
   url => "http://acme.crowdsifter.com/imgs/good.jpg"
   created_at => "2008-09-26T18:21:49Z",
   job_id => 172
}

Here is an example unsuccessful webhook post create request:

{
   rating => null,
   failed => "Image was corrupt or of an unsupported format.",
   url => "http://acme.crowdsifter.com/imgs/bad.jpg"
   job_id => 172
  }

And here is an example post moderation request:

{
   rating => 0,
   id => 2,
   url => "http://acme.crowdsifter.com/imgs/good.jpg"
   created_at => "2008-09-26T18:21:49Z",
   job_id => 172
}

By default webhooks are sent as a post request with a key of "payload" and a value of URI escaped JSON. If you would rather have XML posted to your webhook, append .xml to your webhook url or add format=xml as a query parameter. We've created a simple Merb webhook server that you can modify for your needs.