#Installation
3 simple steps!
- Clone this repository.
- Run the bundle install command.
- Configure the App!
#Configuration
######Adjust these lines to the appropriate config/environments file Access & Secret Key are required
UsabillaApi.configuration.access_key = 'YOUR-ACCESS-KEY'
UsabillaApi.configuration.secret_key = 'YOUR-SECRET-KEY'
#Change 'YOUR-ACCESS-KEY' & 'YOUR-SECRET-KEY' to appropriate values.
Get your access and secret key here: Usabilla Member API
Full Usabilla API documentation: Usabilla API
#Usage
Once you have finished the installation and configuration.
- Navigate to the directory in your terminal/cmd window.
- Run 'rails s'.
- Then go to ' localhost:3000 ' in your browser.
4 API Pages have already been setup and can be accessed through the following routes;
- /api/button
- /api/button/:id/feedback
- /api/campaign
- /api/campaign/:id/results
(To view the json response, add .json to the end of any of the above urls.)
######Accepted Query String Parameters
Usabilla excepts the following query string parameters as values;
Returns the requested subset.
?limit=
Returns the requested subset.
?since=
Note: Only accepts Unix Timestamps