Confused about REST API

1

I have updated phplist to the latest and greatest (3.6.16) which is the suggested download ( Download phpList | Open Source newsletter software | phpList.org ). PS. the page mentions 3.6.15 (just fyi for the powers that be).

My previous install was old (3.3.x).

I started fresh, I downloaded the zip and uploaded the files to my server (first renamed the old folder) initialized and updated the database etc. All works fine.

At first I did not install the REST API plugin ( plugin:restapi [phpList Resources] ) because the plugin page says the API is now part of the installation (3.4.0+).

However, I could not find any settings in the interface to affect the API ?
I did not see any relevant php files in the installation and my interface code was obviously also not working. ChatGPT rewrote my interface code (I had to start somewhere) and that too did not work.

Is there documentation as to what to do to use the embedded API ? To enable it ? To use it ?

Meanwhile I installed the older plugin again and everything is working perfectly fine at the moment. So I’m a happy camper.

But it is my understanding that I should migrate to the new API at some point ?

Lastly, the plugin doesn’t seem to have a settings page anymore. Previous plugin (and/or previous phplist) provided a settings page for the rest api plugin where I could set my server IP as the only IP that is allowed to access the API. That settings page is gone now. Was that old setting stored in the database and is the newly installed plugin using that setting from the database ? Or is the IP limit simply not enforced anymore ?

2

No, that is not necessary. The new API is entirely different and has less functionality.

The plugin configuration is in the Security settings group on the Settings page.

3

Thank you @duncanc .
It doesn’t have an IP field anymore then where I can limit which IP can access the API ?
My old install had that field,

4

@ibPeter

image
image498×278 18.8 KB

5

I now run 3.6.15 which has a visibly different GUI than what you posted. You must be on an older version ?

When I go to Config / Settings this is the security settings group:

image
image673×511 14.8 KB

There is no mention of RESTAPI on that page at all.

6

@ibPeter You have probably installed the wrong version of the plugin. On the documentation page plugin:restapi [phpList Resources] use the download URL. You appear to have used the link to the previous version.

7

I installed:
https://github.com/phpList/phplist-plugin-restapi/archive/stable.zip via the interface. That link is present on the plugin page but indeed I now see a difference between stable.zip and master.zip that I didn’t pick up before:
https://github.com/phpList/phplist-plugin-restapi/archive/master.zip

Can I just over-install master.zip via the ‘install plugin’ button ?