Instructions
You must specify an apikey GET variable before the service will publish anything for you. Ask ryan for a API key if you want one.
Example URL: http://modules.processwire.com/export-json/?apikey=[your API key]
The feed is in JSON format. You may specify 'debug=1' as a GET variable to view the feed format (in addition to your API key).
Other GET variables you may specify
limit | 1-100 (default=10) |
sort | May be created, modified, title, or class_name, optionally preceded by a hyphen to reverse the sort (default=title) |
category | Optional name of category to limit results to. Use name as it appears in URL segment. Example: admin-helper |
of | Specify 1 to turn output formatting on (default=0). This makes BBCode render as HTML, for example. |
debug | Specify 1 to turn on debug mode, which causes the output to be sent in human-readable (non JSON) format. |
callback | Name of callback function. When specified, output is JSONP rather than JSON. |
field | Field name or CSV string of fields you want to retrieve. When omitted, all fields are included. |
class_name | Module class name or CSV string of module class names you want to retrieve. |
Pagination
The feed is paginated with the limit that you optionally specify with the 'limit' variable. The feed includes next_pagination_url and prev_pagination_url properties to make your data retrieval of paginated results easy.
Module Details
The long text fields details and instructions are excluded from the combined module results. You can retrieve these from a module individually by specifying the feed URL with the module name, i.e.
http://modules.processwire.com/export-json/admin-hot-keys/?apikey=[your API key]
Note that each module record also includes a reference to this details URL, called details_url.