REST API | For the geeks

This website uses cookies and other technologies

This website uses cookies and other technologies in order to provide you with the best possible service. By clicking OK or simply using the site, you agree to this data processing. Further information can be found in our privacy policy.

EN | FR

Terms of Service Copyright

Intellifarm SA, Chemin Frank-Thomas 34, 1208 Geneva, Switzerland - Tel +41 22 700 59 29

Documentation

The full documentation for the Wyzio Integration Server is available at the address https://restapi.wyzio.com.

You must be logged in Wyzio to access the information which is designed to provide all the elements you will need to integrate with Wyzio.

Authentication for REST API requests

API calls are authenticated via Web Tokens. At a high level, authentication works by the add-on exchanging a security context with the application. This context is used to create and validate tokens, embedded in API calls.

To use the API, you will need to retrieve the API credentials.
Create a Wyzio contact to handle the API requests at https://wyzio.app/contacts.
Give that contact the user role.
On the User tab, in the permissions area, apply to the contact the « Webservice » role.
Go to the RESTful API section.
A token linked to the account will be shown on this page.
When you generate a request to the REST API, pass in the header the key « WEAL-TOKEN » (Wyzio Enhanced API Library) and, as the value, the token of the user.
All calls must be made using Wyzio/1.0 as User Agent.

How does REST API billing work?

A user assigned the "Webservice" role is billed at the same monthly rate as standard users. For what we consider heavy usage, we have set the limit at 6,000 requests per month, a number typically reached by a user in an accounting firm managing multiple clients. Webservice accounts receive an additional 25% allowance, raising their limit to 7,500 monthly requests. If a user does not use up this quota, the unused requests can be transferred to other active members within the same organization. For example, with 5 active users, the overall quota reaches 37,500 requests per month. Any requests that exceed this total incur additional charges. To calculate these, we divide the total number of requests made by the company during the month by 7,500 to determine the number of surplus units, which are then billed at the standard rate.