API
This documentation is for the WooRewards plugin
Use this API if you want to connect a third party app to WooRewards.
Information
This feature requires programming on the user’s side. Therefore, only developers should use the API.
Disclaimers
Authentication
WooRewards REST API requires a logged user. However, how you log the user is your responsibility.
For security purposes, WooRewards API won’t respond without a logged user.
If you don’t know how to log a user, please use WooCommerce’s documentation.
Permalinks
WooCommerce and WooRewards APIs require the use of permalinks on your website. Go to your website administration, inside Settings → Permalinks and select one of the options different than “Plain”. If you don’t, the API will not respond.
API Settings
In order to set up the API, go to WooRewards → System → API.
Firstly, you need to enable the API by checking the two first options.
Secondly, add the users allowed to access the API.
In addition to the instructions, here’s a description of the available options.
REST API
This section contains the main features of the API.
At the top of the section, there’s also a notice that indicates the url of the API.
User Permissions
In this section, you have to define which users can access the different features and functions of the API. There are different levels of authorizations required, depending on the task performed through the API :
For each section, select the user or users allowed to access the relative features. These are the users that you will use to connect to the REST API.
Information
An Administrator should be set in each list so that he gets the rights to read general information, to read user information and to change user information.