For a code example, have a look at this page.

To get started on working with the Data-API, you will need to follow a couple of simple steps:

1. Register a Hyves account
2. Apply for an API-developer status
3. Create a consumer for your application
4. Choose a library on which to build your application

Register a Hyves account

Each API application is coupled to a Hyves account, so before you can start building an application you will need to register a Hyves account. You can choose between a corporate account or a plain user account. The difference between these two is that a corporate account isn't attached to a profile on Hyves. When you want to use the API for a company, you need a Corporate Account (there are no companies allowed on a plain account).

Apply for an API-developer status

Before you can start developing, you will need to request API-developer status. Before applying for API-developer, please make sure you are logged in to the right account, so before applying as a corporate member, make sure you are logged in at Hyves with the corporate account. You can request API-developer status:


Create a consumer for your application

Each application you will develop with the Data-API requires its own consumer. With this consumer you provide specific application information and server information, it will also behold a request limit and certain spam sensitive methods can be attached, on request. After creating a consumer, you will receive a Consumer Key and Secret. This Consumer Key and Secret are used in your application to identify the specific application on Hyves.

Note: Each API Consumer has a ratelimit, which limits the amount of API calls that can be made from this consumer per hour and day. If your application will need a higher ratelimit, please notify us with an explanation and we will increase this limit.

Choose a library on which to build your application

You can make your own library to handle the data with the API, but you can also have a look at the libraries of some of our dedicated developers from the Data-API community. These libraries are available in several different programming languages (PHP, .NET, ActionScript) and are in most cases documented and contain some examples. It is recommended that you use one of these libraries if you have limited or no experience in developing with API’s.

You are now ready to start developing with the Hyves Data-API!

If you want to try some API calls in a simple way, you can use the API Console and your Consumer Key to see how the API is working and which results you can expect back when creating your application. If you tick the “Load directly in iframe” box, the link will be called directly in the iframe which will display the result. Note: Each link can be used only once to prevent the possibilities of a Replay attack.