The API

"Don't call us, we'll call you" approach to Web Service

SharedCopy provides APIs in the form of callbacks (aka "plugouts" in DabbleDB) that allows you to receive data from us, and process it however you want.

How it works

Whenever somebody comment on a copy, our system will contact your APIs to send them the extracted comments and context for processing. Some examples of what kind of processing could be done: Email the comments to yourself, post to another website, store them in your own database, etc..

API Data Format

The following will be the HTTP POST parameters sent to your callback URL:

1. api_key
   This will be a string of alpha-numeric characters. You will get this once you have created an API
2. user_ip
   IP address of the person who clicked 'Save'
3. user_agent
   User-agent string of the above-mentioned person's browser
4. html
   This is the latest copy of the web page HTML
5. comments
   This is an Atom XML (see example) containing only the new comments in that copy. i.e. previous comments are excluded
6. url
   The URL of the original webpage
7. copy_url
   The URL of the copy, i.e. webpage with comments

Examples

To give you an idea what this callback can be used for, let's look at some implementations below (source code provided).

Terms and Conditions: You expressly understand and agree that SharedCopy.com shall not be liable for any direct or indirect damages resulting from your use of the URLs below.

1) Basecamp Integration

Automatically cross post your comments to your Basecamp project as messages. Send subsequent comments on that copy as comments to that same message. Use the TODO: prefix in your comments, and conveniently create TODO item instead.

Thanks goes to Divya Manian for suggesting this plugin!

To try this demo service:

1. Login to your Basecamp project admin and go to Dashboard > Account and activate Basecamp API
2. Login to your SharedCopy account and go to Top Navigation > APIs > Add a New Callback
3. For Your Callback URL field, provide the following URL http://sharedcopy.com.sharedcopy.com/plugout_basecamp/DOMAINNAME/PROJECTNAME/MESSAGE_CATEGORY
   (replace those uppercase portions with your own information!)
4. Click Require HTTP Basic Authentication? and provide your Basecamp username and password
5. Select I have read and agree to... checkbox, and click Create
6. Bookmark the link under Use this Bookmarklet
7. Use your new bookmarklet on any webpage, type some comments and click Save
8. Check your Basecamp project page to see the new messages and todo items added!

Privacy concern? Feel free to host your own instance - download reference source code

2) Twitter Integration

Put a sticky note on any webpage. Highlight some quote on a webpage. Automatically post them as your Twitter status (including the URL).

To try this demo service:

1. Login to your SharedCopy account and go to Top Navigation > APIs > Add a New Callback
2. For Your Callback URL field, provide the following URL http://sharedcopy.com.sharedcopy.com/plugout_twitter
3. Click Require HTTP Basic Authentication? and provide your Twitter username and password
4. Select I have read and agree to... checkbox, and click Create
5. Bookmark the link under Use this Bookmarklet
6. Use your new bookmarklet on any webpage, type some comments and click Save
7. Check your Twitter page to see your new status!

Privacy concern? Feel free to host your own instance - download reference source code

3) ?

Send in your suggestion!