awe.sm Create API

These endpoints allow you to create awe.sm-powered tracking links for various sharing use-cases.

Please review the key concepts, link creation, and sharing overviews before continuing.

Create a link

url

When your application does authenticated server-side sharing (i.e., via Facebook Connect, Twitter OAuth, etc), use this endpoint to create a unique tracking link with the appropriate metadata to be included in the share. Also supports JSON callbacks for cases in which you need to create a tracking link via AJAX.

Create many links

url/batch

When your application needs to create multiple tracking links at once (e.g. if a user has asked your application to post on their behalf to both Twitter and Facebook), use this endpoint to create them with a single call by specifying an array for one of our metadata fields.

Create a link for unauthenticated sharing

url/share

The simplest way to track sharing with awe.sm. Seamlessly generates a tracking link and loads your desired sharing dialog all in one GET call. Use this endpoint for un-authenticated client-side sharing (e.g. Twitter Web Intents, Facebook Feed Dialog, etc.).

Update a link

url/update/{awesm_id}

If your application is posting on the user's behalf (i.e. via Twitter OAuth, Facebook Connect, etc), there's a bunch of important metadata that can only be known after the share is completed, like the Twitter status_id/Facebook post_id of the message containing the awesm_url, the number of followers/friends/fans the account to which the post was made had at the time of the share, or the exact time the post was made. So, we now offer the ability for your application to update the metadata of a given awesm_url within 30 days of when it was first created. This endpoint should be used in conjunction with the Create Endpoint for use-cases involving scheduling previously composed posts.

Create a placeholder link

url/static

If your application needs to pre-generate a tracking link for display purposes and you don't want to create a new one each time, use this endpoint which will only generate a new link if one doesn't already exist with the specified metadata. For example, if you want to display a short link on every product page for your users to copy and you want a unique link per user but don't want to generate a new link when the same user visits the same page again.

Replace a placeholder link

url/retweet

This endpoint accepts a text string, parses out any URLs in the string, creates new tracking links based on the specified metadata, and returns the text string with the new tracking links substituted in for the URLs it originally contained. Use this when your application needs to share a message with inline URLs and you don't want to have to parse them out just to encode them.

Last updated 2011-10-28