Main Page

= The Sharing API =

What's the idea?
This is a wiki for specifying an API that could be implemented by different services in the Sharing Economy (or Collaborative Consumption) and thus make possible different ways of interoperability, for example serving users with a search that can look through many different services to find what the user is looking for.

This wiki currently describes the API in the level of listing properties and methods needed. It doesn't yet specify the exact syntax, vocabulary, formats etc. but can be worked towards more exact standard.

How to participate
If you want to participate to discussion or creation of a shared API please email antti at sharetribe.com and you'll get access to the wiki.

Projets planning to implement Sharing API

 * Sharetribe
 * currently building their API, trying to make it follow the specifications decided together in Sharing API. The current version of the Sharetribe API specification can be found in Google Docs (anyone can comment there.) The API spec is not yet final and there can be big changes before publishing it.
 * The founders have also been active in promoting collaboration and aiming for common API

There are plenty other services whose makers have expressed interest to be involved. However here is only listed those who have explicitly expressed their intention to implement the Sharing API. (i.e. Feel free to add your service to the list.)

Listing properties
Listing means here the offer, request, posting etc. that each service uses for listing the resources available or resources requested.

These are the stuff that an API request would return for one listing from each service.


 * item local ID unique key combo
 * service_name unique key combo
 * owner local ID
 * title (mandatory)
 * url (mandatory)
 * description (optional)
 * image (optional)
 * type (mandatory)
 * offer
 * request
 * date created (auto)
 * date expiry (optional)
 * share_method (mandatory, listing can have several of these)
 * buy
 * sell
 * rent
 * share (i.e. borrow or lend)
 * swap
 * gift (i.e. free)
 * category
 * item
 * space
 * skill_or_service
 * transportation
 * latitude (optional)
 * longitude (optional)
 * address (optional)
 * price (optional)
 * local currency local ID
 * rate (optional)
 * hourly
 * weekly
 * montly
 * one time payment
 * keywords/tags (optional)
 * language? (there should be a way to search from content on other languages!)
 * condition
 * What does this mean?

An example JSON that a search query would return:

[   {      "owner":"jerry", "title":"Power drill", "service_name":"Sharetribe", "url": "http://randomcommunity.sharetribe.com/listings/167" "description":"A regular power drill I seldom use", "type":"offer", "share_method":"lend" "category":"item" "latitude":40.71455 "longitude":-74.007124 },   {      "title":"Bike repair", "service_name":"Sharedearth.net", "url": "http://www.sharedearth.net/listings/1022" "description":"I am good at repairing bikes and good lend neighbor a hand", "type":"offer", "share_method":"offer_for_free" "category":"skill_or_service" }, ]

Search

 * Example URL: http://api.SERVICE_NAME.DOMAIN/search?api_key=DSF23HG23JSD&limit=10

Parameters

 * api_key (mandatory)
 * query
 * order_by (return results either newest first or nearest first, default newest first)
 * If ordered by nearest first, skip all listings without a location
 * current_location (of the searcher, to make searching by location possible, both lat and long)
 * radius
 * limit (default = 50, ordered by the nearest first)
 * different listing properties

Send message to user
Making it possible to connect the person, without the revealing his email address.

Parameters
Not defined yet

Guides about Media Wiki

 * [//www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list]
 * [//www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]
 * MediaWiki release mailing list