Start to develop

Access the WinBIZ Cloud API

You must be a Partner regulated by the 2017 General Pertnership Conditions in oder to be able to develop Apps and connectors that use the API.

The partners must buy at least one Cloud access; they purchase it with an important discount that allows to develop Apps for Winbiz Cloud event to the smallest companies. The Winbiz Cloud acces can be used to develop and test the applications.

Obtain a free API key

The partner can request a development key as soon as he can access Winbiz Cloud.

The development key can be assigned to one or more useras at the partner: the key gives the possibility to access, through the API, the partner’s data in the Cloud.

Submit an App for approval

The partner can submit a request for approval as soon as he thinks his App is ready to be sold. The approval process ends with the publishing of the App in the Winbiz App Store.

In order to submit an App for approval some data must be transmitted:

  • at least 3 screenshots of the App;
  • the list of the languages the App can be used with;
  • the description of all the functionalities;
  • the description of the pieces of information used by the App and the list of the API methods called;
  • the Winbiz Editions that are compatible with the App (Basic, Professional, Ultimate+)
  • the phone and e-mail contacts of the App helpdesk;
  • the price that the end end customers will pay per month and user.

The App submitted must at least:

  • implement each user login according to the documentation that can be found here
  • implement the error management as specified here

Logged operations

All the operations performed on the Winbiz Cloud API are recorded along with their outcome (success/no success).

Complete log

Each Cloud user can access the complete log of all the operations performed by the Apps through the API on the data.

Surveillance

LOGICIAL SA oversees constantly the usage of the users’ data by third-party Apps.

API documentation

The public documentation of the API is always available. The documentation is available only in English, in order to guarantee a good communication between partners both from Switzerland and from abroad.

Listing on the Winbiz App Store

The Apps can exclusively be purchased by the end-users on the Winbiz App Store

Request a new method or a correction

The Winbiz Cloud API is in constant evolution and we like to enrich it with suggestions and pertinent feedback from the partners.
The improvements and the corrections are communicated via the Version history that is published at each Winbiz update.
The roadmap of the future developments is public and can be accessd at any moment.
The partners can suggest improvements and corrections only using the following form:

Technical documentation

Development key

Contact us