I/O Docs: API Documentation

The Whit.li API is a RESTful web service that was designed to be easy to explore and use. It is our hope that through the base URI, a developer getting started with our API will be able to reach and manipulate our APIs without reading through multiple pages of documentation. This is accomplished by linking related resources and providing instructions on how to use each representation (link templates) in the response itself.

How to Get Started Using Facebook Data

› Get oAuth Token from Facebook (details here)
› Import token to Whit.li
› Request Vector Set from Whit.li
› Get Context Comparison

How to Get Started Using Your Own Data

› Import data to Whit.li
› Request Vector Set from Whit.li
› Get Context Comparison

You can also VIEW OUR WRITTEN DOCUMENTATION

Our written documentation provides the information you will need to:

› Learn more about advanced Whit.li API Methods
› Interpret a Whit.li Vector
› Create a Facebook app

Let's take a quick exploratory dive into the API and see this thing in action. To start out on your journey, simply register for a Whit.li API key. We currently support responses in JSON and XML.

• User

  • List Methods
  • Expand Methods

  • POSTImportToken/user/importToken
    Import a facebook uid and oauth_token combination to allow Whit.li to populate profile, post and interest information. The call imports the token and populates the data from Facebook.

    Parameter	Value	Type	Description
    uid		int	The ID of the user.
    oauth_token		string	Facebook OAuth token.
    format	jsonxmlcsvphp	enumerated	Payload output format.

  • GETPopulate/user/populate
    Request Whit.li to refresh data associated with a given uid and oauth_token pair.

    Parameter	Value	Type	Description
    uid		int	The ID of the user.
    format	jsonxmlcsvphp	enumerated	Payload output format.

  • PUTImportGeneric/user/importGeneric
    Import a generic profile from a JSON object.

    Parameter	Value	Type	Description
    RequestBody	{ "schema":"generic", "uid":"1", "profile_data":{ "first_name":"John", "last_name":"Whitli", "hometown_location":"Austin, Tx", "work_history":[ { "location":{ "city":"Austin", "state":"Texas" }, "company_name":"Whit.li- Explore Minds Like Yours", "position":"Emperor", "description":"", "start_date":"2011-04" } ] }, "posts":[ { "id":"152543539_10150215025383600", "message":"this is a post", "created_time":"2011-12-09T15:46:23+0000" }, { "id":"152543539_10150107473533600", "message":"this is a post", "created_time":"2011-12-08T15:46:23+0000" } ], "likes":[ { "name":"The Black Keys", "id":"8746730308", "category":"Musician/band", "created_time":"2010-05-07T16:35:29+0000" }, { "name":"Austin, Texas", "id":"4034730278", "category":"Community", "created_time":"2010-05-06T16:35:29+0000" }, { "name":"Michio Kaku", "id":"111722405511675", "category":"Author", "created_time":"2010-05-07T16:35:29+0000" } ] }	body	The JSON request object for the API call.
    format	jsonxmlcsvphp	enumerated	Payload output format.

• Key

  • List Methods
  • Expand Methods

  • GETGet/key/get
    Get a Whit.li key. A Whit.li key contains information that describes the various traits of a person. Each Whit.li key contains multiple vectors that have detailed information about an individual based on the individuals psycho-social profile. To learn about the different key values visit: http://developer.whit.li/docs/read/How_to_Interpret_a_Whitli_Key

    Parameter	Value	Type	Description
    uid		int	The ID of the user.
    key_id		int	The ID of the key.
    schema	fbgeneric	enumerated	You can select between fb and generic schemas.
    format	jsonxmlcsvphp	enumerated	Payload output format.

  • GETCompare/key/compare
    Compare two users based on a given context associated with key vectors and components. To learn about the different key values visit: http://developer.whit.li/docs/read/How_to_Interpret_a_Whitli_Key

    Parameter	Value	Type	Description
    uid1		int	The ID of the first user to compare.
    uid2		int	The ID of the second user to compare.
    context_id	100101102103104106	enumerated	The ID of a given context_id to match against. Read interpreting a vector set for more information.
    schema	fbgeneric	enumerated	You can select between fb and generic schemas.
    likes		int	Request for rare interests.
    format	jsonxmlcsvphp	enumerated	Payload output format.