Hi5 API (beta)
Introduction
Welcome to the API for Hi5.com We've got a full SOAP API, and even a few REST endpoints. Feel free to check it out!
Disclaimer
The API service is currently in beta test, this means that interfaces can change without warning.
Send email to api-request@hi5.com if you intend to access this in any way.
SOAP
This API is exposed through a set of WSI Basic Profile -compliant SOAP v1.1 endpoints. The API supports XML-binary Optimized Pacakging (XOP) and SOAP Message Transmission Optimization Mechanism (MTOM) for transmission of binary data. The SOAP API is fully described by the following endpoints:
Namespace http://api.hi5.com/ (wsdl):
Namespace http://api.hi5.com/auth (wsdl):
Namespace http://api.hi5.com/feed (wsdl):
Namespace http://api.hi5.com/fu (wsdl):
Namespace http://api.hi5.com/message (wsdl):
Namespace http://api.hi5.com/metrics (wsdl):
Namespace http://api.hi5.com/notification (wsdl):
Namespace http://api.hi5.com/presence (wsdl):
Namespace http://api.hi5.com/profile (wsdl):
Namespace http://api.hi5.com/profiler (wsdl):
Namespace http://api.hi5.com/status (wsdl):
Namespace http://api.hi5.com/test (wsdl):
Namespace http://api.hi5.com/widget (wsdl):
The SOAP API is also accessible by client-side libraries that can be downloaded from the download page.
REST
This API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model:
- addWidget
- auth/decodetoken
- auth/plain
- auth/renew
- feed/album
- feed/albumlist
- feed/friends
- feed/group/replies
- feed/group/topics
- feed/journal
- feed/photos/user
- feed/photos/user/{userId}/albumid
- friendUpdates/friendUpdate
- getRemoteWidget
- message/sendEmails
- metrics/daily
- metrics/dailyuniques
- metrics/total
- notifications/send
- photoAlbums
- presence/getOnlineFriends
- presence/isOnline
- profile/appdata
- profile/appdatamap
- profile/appdataupdate
- profile/foaf
- profile/lookup
- profile/user
- profile/xpt
- profiler/allstats
- profiler/stats
- status/getFriendStatuses
- status/getStatus
- status/setStatus
- test/auth
- test/echo
- test/exception
- test/oauth
Data
All SOAP endpoints and REST operations act on the same set of data described by XML Schema. The following data (grouped by namespace) are available:
Default Namespace (schema):
Default Namespace (schema):
- Type authTokenBean
- Type count
- Type hi5AuthenticationProvider
- Type longestTimeComparator
- Type profilerStats
Namespace http://api.hi5.com/ (schema):
- Type applicationUpdate
- Type appMetrics
- Type authLevel
- Type AuthToken
- Type contextMetric
- Type dailyMetrics
- Type emailResponse
- Type friendUpdateResponse
- Type hi5App
- Type hi5AppData
- Type hi5AppDataEntry
- Type hi5AppDataMap
- Type hi5AppDataMapEntry
- Type hi5AppDetails
- Type hi5AppProvider
- Type hi5AppStatus
- Type hi5AuthType
- Type hi5ErrorResponse
- Type hi5SuccessMessage
- Type memberStatus
- Type memberStatusList
- Type metric
- Type metrics
- Type notification
- Type notificationResponse
- Type onlineFriend
- Type onlineFriends
- Type photo
- Type pointUsage
- Type profile
- Type profilerStatsWrapper
- Type testResponse
- Type user
- Type userId
- Type userVcard
- Element activity_response
- Element appdata
- Element appdatamap
- Element application
- Element applicationUpdate
- Element authlevel
- Element authToken
- Element details
- Element email_response
- Element error_response
- Element hi5appProvider
- Element memberStatus
- Element memberStatusList
- Element metricsResponse
- Element notification
- Element notification_response
- Element onlineFriend
- Element onlineFriends
- Element pass
- Element profile
- Element profilerStatsWrapper
- Element TestResponse
- Element user
- Element userId
- Element userVcard
Namespace http://api.hi5.com/xpt (schema):
- Type Blog
- Type BlogEntries
- Type BlogEntry
- Type BlogList
- Type Blogs
- Type Comment
- Type CommentList
- Type Comments
- Type FriendList
- Type FriendProfile
- Type Friends
- Type Group
- Type GroupList
- Type Groups
- Type Location
- Type Media
- Type MediaEntry
- Type MediaList
- Type objectFactory
- Type Shopping
- Type UserMedia
- Type UserProfile
- Element Blog
- Element BlogEntries
- Element BlogEntry
- Element BlogList
- Element Blogs
- Element Comment
- Element CommentList
- Element Comments
- Element FriendList
- Element FriendProfile
- Element Friends
- Element Group
- Element GroupList
- Element Groups
- Element Location
- Element Media
- Element MediaEntry
- Element MediaList
- Element Shopping
- Element UserMedia
- Element UserProfile
Namespace http://opensocial.org/2008/opensocial (schema):
- Element count
Namespace http://purl.org/syndication/history/1.0 (schema):
- Type completeType
- Element complete
Namespace http://www.w3.org/1999/02/22-rdf-syntax-ns# (schema):
- Type rdfResource
- Element RDF
Namespace http://www.w3.org/2005/Atom (schema):
- Type categoryType
- Type contentType
- Type entryType
- Type feedType
- Type generatorType
- Type iconType
- Type idType
- Type linkType
- Type logoType
- Type objectFactory
- Type personType
- Type sourceType
- Type textType
- Type uriType
- Element entry
- Element feed
Namespace http://xmlns.com/foaf/0.1/ (schema):
- Type foaf
- Type foafPersonKnows
- Type Person
- Element knows
- Element Person
Namespace http://xspf.org/ns/0/ (schema):
- Type AttributionType
- Type ExtensionType
- Type LinkType
- Type MetaType
- Type objectFactory
- Type PlaylistType
- Type TrackListType
- Type TrackType
- Element track