Page 1 of 3

[ABD] phpBB API

Posted: Mon Jan 14, 2013 11:02 pm
by Geolim4
  • MOD Title: phpBB API
  • MOD Autor: Geolim4 < N/A > http://geolim4.com
  • MOD Description: That MOD will provide to your board a RESTfull API able to communicate in many format: JSON, XML, HTML. Five output formats are available: serialized, xml, json, HTML and raw.
    Two type of key are available:

    User key:
    • can be created from their User Control Panel (with ACP default configuration!)
    • can be set to "read only" mode
    • with or without authentication
    • allow an administrator's choosen file download upon succesfull authentication
    Administrator keys:
    • API users Features
    • cache purging*
    • deleting* users, threads, messages; baning* users
    • style managing*
    • other functionalities planed 8)
    • requesting for DB's datas**

      • (Possibility to exclude API table from DB management fro security reasons evenr with left/right join)
    *Thus being a "read/write" access

    **Repeat after me:
    Geolim4 wrote:I'll be very carefully during key's creation with database access. I'm aware that keys should be created only for remote managing, by human or program (bot). I also know well that database's access with advanced permissions can endanger API table.
    API will be managed through unique key, thus allowing a better management:
    • you can put limitation to requests' count, on day, week or month basis
    • you can force key expiration
    • you can limit access to one IP address or set of IP addresses
    This MOD let your board being accessible for developpers, like executing C/C++ programs for authentication, or using cURL/f(sock)open, and more.
    A full knowledge base coupled with a FAQ is included with the MOD. Please read it carefully before posting :!:
  • MOD Version: 0.0.1
  • Installation level: Easy
  • Installation time: 2 min (Only one file to modify)
  • Download: here MD5: 2ec8af1431932c7a2dce1ad934ea3f49
  • Demonstration:
    • N/A
  • Notes:
    • Requests and remarks should be made in the current topic only (NO MP)
    • Available languages: English / French
  • Screenshots:
    Image Image Image Image Image Image Image Image Image Image Image Image

Re: [ALPHA] phpBB API

Posted: Mon Jan 14, 2013 11:15 pm
by Geolim4
Feature accepted:
  • -Different Database Username from forum

Features in Consideration:
  • -Possibility to use a wildcard for assigned key IP

Features rejected:
  • -Different Database Username from forum for each API Keys

Re: [ALPHA] phpBB API

Posted: Wed Jan 16, 2013 9:24 pm
by keith10456
This could be very useful.

There's also been discussions of a phpBB API in Area51 for 3.1. Maybe you should see where the dev team is going with theirs ;)

Re: [ALPHA] phpBB API

Posted: Sat Mar 02, 2013 11:10 pm
by Citromon
Is very interest. So a pity, that only you one create this mod.

Re: [ALPHA] phpBB API

Posted: Fri May 24, 2013 8:37 am
by EsmerÖzcan
any news?

Re: [ALPHA] phpBB API

Posted: Sat May 25, 2013 3:41 pm
by Geolim4
I'm working on it, but it take me a lot of time 8-)

Re: [ALPHA] phpBB API

Posted: Thu Oct 31, 2013 8:18 am
by Geolim4
Hello folks,
Here are the first screenshoot, the first version should be available in December (2013)
You can see below many screenshoot, including my fatal error handler 8-)
An hook system forked from Automod allow you to install/uninstall hook easily :mrgreen:
Image Image Image Image Image Image Image Image Image ImageImage

Stay tuned ;)

Re: [ALPHA] phpBB API

Posted: Thu Oct 31, 2013 3:25 pm
by keith10456
Thanks for the update! I truly look forward to this... It would be a great step forward for phpBB!

On a side note, if you didn't see it already, you might want to sneak a peak at this RFC on Area 51.

Re: [ALPHA] phpBB API

Posted: Fri Nov 01, 2013 12:48 am
by Geolim4
Mhhh i will see the status of 3.1.x, if an real API appear for 3.1.x so i will no longer keep this project up-to-date 8-)

Re: [ALPHA] phpBB API

Posted: Fri Nov 01, 2013 8:34 am
by Mess
Looks like you made a lot of progress on this. Congratz. :)
Ill be following development.

Re: [ALPHA] phpBB API

Posted: Fri Nov 01, 2013 8:38 am
by Geolim4
The API will use a lot of awesome library/framework: jquery(UI), lazyload, easytabs, pChart 2.x, maphighlight etc...
phpBB API will probably require php 5.3.x: Anonymous functions, OOP, etc...

Re: [ALPHA] phpBB API

Posted: Fri Nov 01, 2013 1:21 pm
by keith10456
geolim4 wrote:Mhhh i will see the status of 3.1.x, if an real API appear for 3.1.x so i will no longer keep this project up-to-date 8-)
The link I posted was just an RFC... I don't think any progress has been made on it. I posted the link so you can see some of the comments/tips from the devs ;)

Re: [ALPHA] phpBB API

Posted: Fri Nov 01, 2013 1:26 pm
by Geolim4
Right, the branch 3.0.x still in plan, not sure for 3.1.x, i need to bump that topic before.

Re: [ALPHA] phpBB API

Posted: Fri Nov 01, 2013 2:48 pm
by Kamahl19
Creating a good API is not a simple thing. Have you considered all security issues?
Why are you creating a MOD instead of making this for 3.1? I personally think it would be more useful.
I am glad someone finally started with this. As far as I remember there was some attempt to create API by some phpbb.com team member, but he created only a skeleton. Maybe you could inspire from it too.

Re: [ALPHA] phpBB API

Posted: Fri Nov 01, 2013 2:50 pm
by Geolim4
I will finalize the 3.0.x project as of phpBB 3.0.x still popular for long time...
phpBB 3.1.x isn't planned yet for the simple reason than i don't know the framework for now ;)

Another awesome new screenshoot from the stat page:
Image

I will publish a test key coming soon ;)