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
- I Am Using Kimono Labs To Fill In Gap For Companies Who Do Not Have AN RSS Feed For Their Blog
- Someone Please Build My Open, Interactive, Portable, And Visual API Documentation Toolkit
- Dwolla Using Slate For An Evolved API Documentation Experience
- Crazy Mess Of URLs Across 400 Of The APIs In My Stack
- Reworking My API 101 Content: Consuming APIs
- I Need Help To Make Sure The Dept. of Agriculture Leads With APIs In Their Parks and Recreation RFP
- What Is The Biggest Challenge For Fraud Detection API SiftScience?
- Reworking My API 101 Content: Providing APIs
- What I Spent Ada Lovelace Day Working On
- An Outside-In Approach To Jumpstarting An API Effort At The University of Oklahoma