https://github.com/christianesperar/web-service-template
ProcessWire web service implementation using template
https://github.com/christianesperar/web-service-template
php processwire
Last synced: about 1 year ago
JSON representation
ProcessWire web service implementation using template
- Host: GitHub
- URL: https://github.com/christianesperar/web-service-template
- Owner: christianesperar
- Created: 2014-08-24T05:09:29.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2018-01-28T16:56:00.000Z (over 8 years ago)
- Last Synced: 2025-04-01T03:41:56.764Z (over 1 year ago)
- Topics: php, processwire
- Language: PHP
- Size: 16.6 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WebServiceTemplate
ProcessWire web service implementation using template
Use template URL segment to identify what page should be returned. All output is generated in JSON format.
# Supported fields
This are the current supported fields. Feel free to edit this part if the field you are using is supported.
* Comments
* Image
* Map Marker
* Page
* Repeater
* Text
* Textarea
# Supported Version
This template is tested on ProcessWire version 2.4 up to 3.
# Supported Modules
This are the current supported fields. Feel free to edit this part if the modules you are using is supported.
* CommentRatings
# Installation
### Template
* Add a template **web-service** with no other fields and configure it to allow **URL Segments**
* Add a field name **secret_key** and **site_prefix** (optional)
* Add a template **configuration** and add the field **secret_key** and **site_prefix** (optional)
### Page
All page must be child of the Home
* Add a page with **configuration** as a template and enter your **secret key** to access the content and **site_prefix** (optional) you want to remove
* Add a page with **web-service** as a template
# Calling
You can call specific page by **http://root/web_service_url/secret_key/page_url** (ex: **http://root/web-service/12345/example**)
# Reserve URL
* Home must be called by using **home** as **page_url** (ex: **http://root/web-service/12345/home**)
# Live Implementation
Some site use this template is:
[N-340 Website](http://n-340.org/) - [JSON](http://n-340.org/api/app/json/)
# Tips
Increase the maximum URL segment to avoid future error. You may modify this setting in your /site/config.php file and add $config->maxUrlSegments = 10 on the end of the line.
# Todo
Automate the installation
# Support
Get support in the WebService template at [ProcessWire forum](https://processwire.com/talk/topic/7369-webservicetemplate/).