Data-API

 

Methods

The Data-API, or Application Programming Interface, is an interface which handles requests from a external web server. Basically this means that the Data-API is a standardized method to request or send specific information from (or towards) Hyves. . You can use the Data-API to post content on Hyves such as photo’s, video’s, status updates (or as we call them www’s), blog and tips but also to display content from Hyves on your own website.

In short this comes down to the following: a website’s API defines the right way for a developer to send and request data from this website. A developer can integrate the right methods into his application and make sure that he receives the correct information.

Example

An external website wants to allow their visitors to easily install a gadget from their website. With the use of the API, the visitor can allow the website to communicate with Hyves and install the gadget on his profile.

Possibilities of the Data-API

The Data-API offers a wide range of functionalities such as:

  • Sending messages to your friends on Hyves
  • Sharing your photo albums
  • Retrieving the latest activities of your friends or famous Hyvers
  • Creating blogs, tips and www’s

For an overview of all API functionalities, check out the methods page.

The API has multiple levels of available methods and offers a wide variety of public methods and a selection of private methods which are only available with the permission of Hyves.

Public methods

Public methods are usually sufficient to create an application which shows information from Hyves such as a photo album. These public methods often use information which is publicly available on Hyves and can be shared with other Hyvers.

Private methods

Certain methods are defined as being private. These methods are usually methods which are spam and security sensitive and are because of this reason only available for specific partners. If you would like to use one of these private methods, let us know at hyves-api[at]hyves[dot]nl.

Example

A Hyver has created page on his own website which shows an overview of his latest WWW’s. He can simply create this page by using the method wwws.getByUser to retrieve his latest WWW’s and use the methods wwws.getComments and wwws.getRespects to display the comments and respects het received on these WWW’s. However we do not allow this Hyves to create the possibility to comment on these WWW’s due to the spam sensitive nature of this method.