Posted on 05-07-2012
Twitter has an innovative approach to presenting the objects that make up the Twitter Platform. They have built a field guide to Twitter Platform objects, designed like an Audubon Society field guide, describing the four primaty Twitter objects:
- Tweets - Also known as a Status Update, Tweets are the basic atomic unit of all things Twitter. Users create Tweets. Tweets can be embedded, replied to, favorited, unfavorited, retweeted, unretweeted and deleted.
- Users - Users can be anyone or anything. They tweet, follow, create lists, have a home_timeline, can be mentioned, and can belooked up in bulk.
- Entities - Entities provide metadata and additional contextual information about content posted on Twitter. Entities are never divorced from the content they describe. After May 14th, 2012 Tweet Entities will be returned wherever Tweets are found in the API. Entities are instrumental in resolving URLs.
- Places - Places are specific, named locations with corresponding geo coordinates. They can be attached to Tweets by specifying a place_id when tweeting. Tweets associated with places are not necessarily issued from that location but could also potentially be about that location. Places can be created and searched for. Tweets can also be found by place_id.
It is a creative way to educate users about the Twitter API, making it more visually appealing. Beyond that, I'm not sure it helps developers get up and running using the API, but who knows...it might make it more accessible to some users.
Have you seen any other creative wasy of displaying API documentaton?
comments powered by Disqus
Winning in the API Economy
|Download as PDF|
Latest Blog Posts
- What Version Of The API Economy Are You Investing In?
- I Am Up To 34 APIs Out Of The Netherlands
- Hello World Product API With Blueprint, RAML And Swagger
- The New Github Developer Program and Integrations Page
- I Have A Valuable API Resource, What Now?
- A Better Understanding Of Government APIs And Their Consumers Before Considering Charging For Use
- So You Wanna Do a Spreadsheet or Database To API Startup
- Jumpstarting the Automobile API Conversation With Carvoyant
- Some Of The Common Building Blocks of Payment APIs
- API Badging and Credentialing To Demonstrate Skills