JSON API for phpBB forums
What is phpbb.json?
phpbb.json is a JSON API for phpBB 3.1 forums. It is designed to operate independently of the phpBB forum, but uses some phpBB components (dbal) for ease of use.
What can I do with it?
Whatever you'd like. You can install phpbb.json on your forum and allow users to easily create applications using your forum's data. One potential use would be a mobile phone application for phpBB forums (like Tapatalk, perhaps, but focused on phpBB forums to provide a better user experience).
Is my data safe?
phpbb.json utilizes phpBB's permissions to determine what data is exposed. Users will have access to no more information than they would if they browsed your board via the standard interface.
Who's behind this?
Who can contribute?
Anyone! This project is hosted on Github and licensed under GPLv2. I welcome pull requests for features, bugs, documentation, or anything else you care to contribute. If you'd like to be involved as a long-term contributor, please contact me.
What's this about testing?
All contributed features must be testable via phpUnit. Bug reports with failing tests are equally encouraged :)
This is a preliminary list of planned features, and is subject to change.
- Authentication, with auth plugin support
- Forum listing
- Topic posting/reply
- Private messaging
- Topic actions (quote, report)
- Topic moderation
- Forum moderation
- Push notifications
This is development software and is not feature-complete nor ready for public consumption. To install on a testing environment, just drop the api/ folder into your board root.
A script that sets up a development environment and runs some automated tests will be coming soon.