We are happy to announce that development of the Event Espresso 4 REST API has begun. You are invited to get involved with the API development by: sharing feedback on the direction of the API, contributing code, testing what is already completed, and encouraging others to get involved.
APIs are for Sharing, Please Share
WordPress and Event Espresso Developers will be most interested in the EE4 REST API, because it will allow for faster development of a wide array of features, including custom reporting tools, mobile application development, and theme development. The EE4 REST API will provide an easy to use API, available via HTTP, to grab your site’s event and registration data in simple JSON format. Retrieving or updating data is as simple as sending a HTTP request.
Purpose of the Event Espresso 4 REST API
Other WordPress plugins that intend to use Event Espresso 4 data server-side (in the PHP code) generally do not need to use the API, and can instead use Event Espresso 4’s models, config, and other modules directly. Check out developer.eventespresso.com for tutorials on how to use many of these systems.
Example applications could include:
- Mobile applications for signing attendees into events in Event Espresso
- WordPress plugin that controls Event Espresso data entirely on the client-side
Generally, the work will be organized into 3 main milestones:
- READ functionality (API clients will be able to read just about anything from EE4, including information from add-ons)
- WRITE functionality (API clients will be able to create and update most EE4 info, but we’d like to prevent API clients from breaking the DB so that will be a bit of a challenge)
- Single page checkout (SPCO) functionality (we will want to present similar functionality to SPCO, except over the API. This will require rather tight integration with SPCO in order to keep them almost identical)
Current progress (as of this writing):
- READ functionality is approximately 85% completed. We are actively working on the compatibility with the permissions and capability controls that are built into Event Espresso core.
- WRITE functionality: 0% completed
- SPCO functionality: 0% completed
Information for Non-developers
I’m not a developer, how does this affect me?
Not a developer, that’s okay! The Event Espresso REST API will allow other applications (other websites, mobile apps, etc) to access your Event Espresso data through an application programming interface (API).
We recommend you share this with your development team, agency or app developers because they will be excited about this. You should ask them to consider building an integration for the Event Espresso 4 API so that you can use your data in their applications.
Another benefit of the API is that if you want a certain edge case feature that is not available in our core products, you can hire a developer to build it for you, without having to understand the Event Espresso 4 code base.
Information for Developers
How do I get access to the files?
How do I get involved?
For the most part, at the time of this writing, we are still in the planing and development stages. Developers that are interested in the Event Espresso 4 REST API can get involved in the development and planning process from within the EE4 REST API page on Github.com.
Participate in a short survey!
How will you, or your company use the EE4 REST API? Let us know by filling out the survey below.