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

EN | FR

         

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 with the « Webservice » role assigned is billed like a regular user on a monthly basis. Effectively, we consider 6 000 requests per user per month as a heavy usage of the system. a user in a CPA firm having multiple clients usually does around 6 000 requests a month. We give an extra 25% on this heavy usage for webservice accounts, thus making 7 500 requests per month. If a user doesn’t use its quota, it is reported on other active users in the same organization. So, with 5 active users during the month, there is a quota of 37 500 requests. The exceeding requests are billed by dividing the total number of requests of the company during the month by 7 500 to calculate the missing units which are then billed following the standard pricing.

Get a demo