ryancramerdesign / servicepages

ProcessWire Pages Web Service

ProcessWire Pages Web Service (ServicePages Module)

Enables ProcessWire-selector style $pages->find() queries via a web service. This web service is suitable for calling from Javascript/jQuery, PHP, etc. All output is generated in JSON format.

For the most part, you can do anything with this web service that you would do with a $pages->find() call. However, for security reasons, the limits of what can be searched and retrieved must be specified in the module configuration.

This module essentially provides a safe front-end to the AJAX API provided in the ProcessPageSearch module, enabling that capability to be used outside of the admin.

Once installed, this module creates a page called /service-pages/. View that page for detailed instructions and examples on how to use it.

servicepages's Issues

Output Repeater values

I'm currently building an app using ProcessWire. I'm using the ServicePages module to expose my data as a REST-like API.

I'm also using the Repeater FieldType. However, the repeater field values aren't outputted in the API. Right now I'm only getting meta data for the repeater values:

reel_captions: [
    {
        id: 1060,
        parent_id: 1059,
        template: "repeater_reel_captions",
        name: "1468607646-89-1",
        path: "/processwire/repeaters/for-field-163/for-page-1/1468607646-89-1/",
        title: null
    }
]

How do I get the actual values outputted?

Posted this on StackOverflow as well.

Omit empty fields

If a field is empty, is there a way to emit it, so i don't get a response filled with null values like so:

{
    "selector": "template=reel, limit=25",
    "total": 1,
    "limit": 25,
    "start": 0,
    "matches": [{
        "id": 1,
        "parent_id": 0,
        "template": "reel",
        "path": "\/",
        "name": "home",
        "created": -62169955622,
        "modified": 1468539079,
        "title": "Reel",
        "body": null,
        "article_content": null,
        "article_gallery": null,
        "article_title": null
    }]
}

Tilde character in selector is sanitized

The attached image pretty much says it all. Tilde (~) is supposed to be allowed in selector string but appears to be being sanitized to an underscore (_). I suspect a change to sanitizer, but just guessing.

(Applies to current stable 2.7.n)

Define displayFields per page/template

Braaw...

Currently each request ends in the "same" json output. Same properties, as defined under "Fields that will be included in results".

I think it would great, if we could define those fields for each page/template...

What do you think?

$this in static config

https://github.com/ryancramerdesign/ServicePages/blob/master/ServicePages.module#L287
https://github.com/ryancramerdesign/ServicePages/blob/master/ServicePages.module#L288

those have to be changed to wire("config")

limit not working

This line write the default to the get request which makes it impossible to specify a limit.

https://github.com/ryancramerdesign/ServicePages/blob/master/ServicePages.module#L122

You do not have permission to execute this module

As mentioned on the forum:
https://processwire.com/talk/topic/1654-pages-web-service-servicepages/page-4

Adrian opened an issue here too on the main Processwire Github page:
ryancramerdesign/ProcessWire#520

There seems to be a bug in Modules.php at line 837, which does only allow superusers to view the output. I'd rather not edit the core as you can imagine, and this bug is preventing me to build an app that can pull info from PW. I hope you can take a look at it soon.