WordPress REST API allows external applications, like Mobile Apps or other Non-WordPress web applications, to interact with your WordPress site. This is done through JSON data exchanges between both parties. We are happy to announce that with the recent release of the BadgeOS REST API add-on, BadgeOS now supports this interface. As a result, developers now have the option to expand their BadgeOS environment by connecting it to external applications.

BadgeOS REST API Features

The BadgeOS REST API Add-on requires an API key and endpoints in order to support sending and receiving data. For this reason, the add-on allows you to create an API Key with permissions to read, read and write, or admin restricted read and write. Endpoints are used to establish interactions between the BadgeOS environment and external applications. For this reason, the add-on includes endpoints for all BadgeOS post types (achievements, point types, and ranks).

Use Cases

This is specifically useful for programmers who have to work on multiple systems and award badges/ranks/points from 3rd party applications. The add-on allows them to establish communication between the BadgeOS environment and other applications by sending and receiving JSON data.

For example, let’s say you have a Drupal e-learning website and would like to use BadgeOS to award achievements for course completion. In this case, installing BadgeOS would be impossible, but you can take advantage of its functionalities using REST API. When a course is completed by a user, REST API can be called to award a badge. Then, the achievements data can be fetched and displayed using REST APIs on a user profile page on the Drupal site.

Conclusion

The BadgeOS REST API add-on is ideal for developers looking to connect a BadgeOS environment to external applications. You can download the add-on here. If you have any feedback or questions, please let us know in the comments below. You can also learn more about the REST API add-on and how it works by going to the documentation.