[DEV] phpBB API

Geolim4 · Post by **Geolim4** » Thu Mar 20, 2014 6:41 pm

phpBB API

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

This extension is a port of my MOD from phpBB 3.0.x.

Status:

Started

Requirements:

phpBB 3.1-dev or higher
PHP 5.4.10 or higher

Repository: https://github.com/Geolim4/phpbb-API/tr ... p-ascraeus
Currently first commit from 3.0.x branch

Important: This Extension can only be installed on phpBB 3.1. Do NOT use this on a live board. It should only be installed for testing purposes or just to check it out. No support will be provided.

Installation:
-Chapter not available for now

Screenshot:

bashekking · Post by **bashekking** » Mon Sep 01, 2014 11:38 am

Hi,

The API seems to be exactly what I'm looking for! However, I'm not able to install it on a fresh install (not an update) of 3.1 RC3.
First of all the whole directory /includes/db was missing, and and db_tools.php could not be found. I copied it.

Then I got the following error which I was unable to solve:

Fatal error: Call to undefined method phpbb\template\twig\twig::set_custom_template() in /home/bas/development/codefined.com/phpbb/phpBB3/umil/umil_frontend.php on line 71

Any help would be greatly appreciated.

Kind regards,

Bas

david63 · Post by **david63** » Mon Sep 01, 2014 1:24 pm

From what you have posted it looks as if you are trying to install a 3.0.x mod onto a 3.1 board - there is no way that it will work. You need to have the extension and it looks to me as if it may have been abandoned.

John P · Post by **John P** » Mon Sep 01, 2014 3:25 pm

Very nice, I'm going to work with this.

StylesFactoryCom · Post by **StylesFactoryCom** » Sun Sep 07, 2014 8:00 pm

I am waiting for this extension!

Keep working

noth · Post by **noth** » Thu Sep 11, 2014 9:17 pm

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

I don't understand what this is offering

a RESTfull API able to communicate in many format: JSON, XML, HTML?

can you give an example of how it would be useful? the screenshots would normally give a clue but this must be the exception to the rule

Mess · Post by **Mess** » Fri Sep 12, 2014 8:49 am

noth wrote:
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
I don't understand what this is offering

a RESTfull API able to communicate in many format: JSON, XML, HTML?

can you give an example of how it would be useful? the screenshots would normally give a clue but this must be the exception to the rule

If you don't know what it means you don't need it.

david63 · Post by **david63** » Fri Sep 12, 2014 10:00 am

noth wrote: a RESTfull API able to communicate in many format: JSON, XML, HTML?

Perhaps this may help

StylesFactoryCom · Post by **StylesFactoryCom** » Fri Oct 24, 2014 11:37 pm

I see that this mod is abandoned

My Extensions & MODs · Post by **VSE** » Sat Oct 25, 2014 4:56 am

Github repo link needs updating

Kamahl19 · Post by **Kamahl19** » Sat Oct 25, 2014 10:07 am

Geolim, do you plan to extend this Ext so much that it will be possible to use it to create an AngularJS frontend with all features for phpbb?

Geolim4 · Post by **Geolim4** » Sat Oct 25, 2014 3:59 pm

I wont update this MOD to Ascraeus, sorry.

advertisements