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/invite (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/payment (wsdl):
Namespace http://api.hi5.com/presence (wsdl):
Namespace http://api.hi5.com/profile (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:
- /auth/decodetoken/{authtoken}
- /auth/loginToken
- /auth/plain
- /auth/renew
- /clientlib/import
- /clientlib/invite
- /clientlib/registration
- /clientlib/search
- /feed/album
- /feed/albumlist/{userId}
- /feed/group/replies/{groupId}
- /feed/group/topics/{id}
- /feed/groups/{userId}
- /feed/journal/{userId}
- /feed/photos/user/{userId}
- /feed/photos/user/{userId}/albumid/{albumId}
- /feed/photos/user/{userId}/albumid/{albumId}/photoid/{photoId}
- /friendUpdates/friendUpdate
- /friendUpdates/latest
- /getRemoteWidget
- /invite/sendInvites
- /message/sendEmails
- /metrics/daily
- /metrics/dailyuniques
- /metrics/hourly
- /metrics/hourlyuniques
- /metrics/total
- /notifications/send
- /payment/coins/{userId}
- /payment/coins/{userId}/increment
- /payment/coins/{userId}/redeem
- /payment/purchaseIntent
- /payment/redemption
- /payment/transaction/{transactionId}/reverse
- /photoAlbums
- /presence/getOnlineFriends
- /presence/isOnline
- /products/{productId}
- /profile/foaf/{userId}
- /profile/lookup
- /profile/user/{userId}
- /profile/views/{userId}
- /profile/xpt/{encryptedId}
- /status/getFriendStatuses
- /status/getStatus
- /status/setStatus
- /test/auth
- /test/buildnum
- /test/echo
- /test/exception/{exception_name}
- /test/oauth
- /test/releasenum
- /users/{userId}/possessions
- /users/{userId}/possessions/{possessionId}
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 e13nUtil
- Type filterOp
- Type filterType
- Type sortBy
- Type sortOrder
Namespace http://api.hi5.com/ (schema):
- Type applicationUpdate
- Type appMetrics
- Type assetList
- Type assetResponse
- Type authLevel
- Type AuthToken
- Type bundleResponse
- Type bundleResponseList
- Type clientLibResponse
- Type context
- Type contextMetric
- Type emailResponse
- Type errorCode
- Type fbAuthToken
- Type friendInvite
- Type friendInviteResponse
- Type friendSet
- Type friendUpdateResponse
- Type hi5App
- Type hi5AppDetails
- Type hi5AppProvider
- Type hi5AppStatus
- Type hi5Auth
- Type hi5AuthType
- Type hi5ErrorResponse
- Type hi5Response
- Type hi5SuccessMessage
- Type invitationResponse
- Type memberStatus
- Type memberStatusList
- Type metric
- Type metrics
- Type microFriendUpdate
- Type microFriendUpdateImage
- Type microFriendUpdateResponse
- Type notification
- Type notificationResponse
- Type onlineFriend
- Type onlineFriends
- Type photo
- Type pointUsage
- Type possessionList
- Type possessionResponse
- Type productList
- Type productResponse
- Type profile
- Type profileViews
- Type purchaseIntentResponse
- Type redemptionResponse
- Type registration
- Type registrationResponse
- Type searchType
- Type status
- Type testResponse
- Type textResponse
- Type timestampedMetrics
- Type user
- Type userId
- Type userItem
- Type userList
- Type userVcard
- Element activity_response
- Element application
- Element applicationUpdate
- Element asset
- Element asset_list
- Element authlevel
- Element authToken
- Element bundle
- Element bundles
- Element details
- Element email_response
- Element EnvironmentInformation
- Element error_response
- Element friend_update
- Element friendInvite
- Element friendInvite
- Element friendSet
- Element hi5_response
- Element hi5appProvider
- Element hi5AuthToken
- Element invitation_response
- Element memberStatus
- Element memberStatusList
- Element metricsResponse
- Element microFriendUpdate
- Element microFriendUpdateImage
- Element notification
- Element notification_response
- Element onlineFriend
- Element onlineFriends
- Element pass
- Element possession
- Element possessions
- Element product
- Element products
- Element profile
- Element purchaseIntent
- Element redemption
- Element registration
- Element registrationResponse
- Element TestResponse
- Element user
- Element userId
- Element userItem
- Element users
- 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://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