1. Documentation
  2. Rest API Extended
  3. Getting Started

Getting Started

Rest API Extended introduces new rest API endpoints to extend interaction between your gamification environment and external applications.

This add-on completely makes use of the official WordPress rest API. For any question about WordPress rest API like endpoints, CRUD operations or authorization, please, check the official rest API handbook.

Also, you should revise the add-on configuration to setup the base URL you want since this will affect to all endpoints.

Authorization

Any endpoint from Rest API Extended add-on requires an administrator logged in on rest API.

Log in on your dashboard won’t log in you on rest API!

Check authentication chapter from WordPress rest API handbook for more information.

Reference

You can make a rest API discovery by perform a request to /wp/v2/{base-url}.
Since base URL by default is “gamipress”, the discovery endpoint by default is /wp/v2/gamipress

Points Extended Controller
Get points
Award points
Deduct points
/wp/v2/gamipress/get-points
/wp/v2/gamipress/award-points
/wp/v2/gamipress/deduct-points
Achievements Extended Controller
Get achievements
Award achievement
Revoke achievement
/wp/v2/gamipress/get-achievements
/wp/v2/gamipress/award-achievement
/wp/v2/gamipress/revoke-achievement
Ranks Extended Controller
Get rank
Get next rank
Get previous rank
Award rank
Revoke rank
Upgrade to next rank
Downgrade to previous rank
/wp/v2/gamipress/get-rank
/wp/v2/gamipress/get-next-rank
/wp/v2/gamipress/get-previous-rank
/wp/v2/gamipress/award-rank
/wp/v2/gamipress/revoke-rank
/wp/v2/gamipress/upgrade-to-next-rank
/wp/v2/gamipress/downgrade-to-previous-rank
Requirements Extended Controller
Award requirement
Revoke requirement
/wp/v2/gamipress/award-requirement
/wp/v2/gamipress/revoke-requirement
Was this article helpful to you? Yes No

How can we help?