Skip to content
This repository has been archived by the owner on Dec 30, 2023. It is now read-only.

Latest commit

 

History

History
115 lines (83 loc) · 6.24 KB

README.md

File metadata and controls

115 lines (83 loc) · 6.24 KB
Raw

zenphoto-json-rest-api

A Zenphoto plugin that provides a JSON REST API to retrieve albums and run searches.

It's useful for building mobile apps and javascript-heavy web apps on top of Zenphoto.

The API is read-only; it cannot create or modify albums or images.

PHP 5.4+ required.

Installation

  1. Place json_rest_api.php and the folder json_rest_api in the /plugins folder of your Zenphoto installation
  2. Activate the plugin from your Zenphoto administration panel, under the Plugins -> Development tab

Usage

Use your normal gallery URLs but add a query string parameter named "json" to get a JSON representation.

Albums:

  • http://mysite.com/myAlbum/?json get JSON about myAlbum and its immediate child albums

Images:

  • http://mysite.com/myAlbum/myImage.jpg?json get JSON about myImage.jpg

Search:

  • http://mysite.com/page/search/train/?json get JSON about the first page of search results about 'train'

The gallery itself:

  • http://mysite.com/?json get JSON about the gallery itself and the top-level albums

Pagination

By default, results are paginated in the normal Zenphoto pattern. Get subsequent pages of results like this:

  • http://mysite.com/myAlbum/page/2/?json get JSON about myAlbum and the second page of its immediate child albums
  • http://mysite.com/page/search/train/page/2/?json get JSON about the second page of search results about 'train'

Use "pagination=off" to return the full unpaginated set of results:

  • http://mysite.com/myAlbum/?json&pagination=off get myAlbum and all its descendants, unpaginated
  • http://mysite.com/page/search/train/?json&pagination=off get search results about 'train', unpaginated
  • http://mysite.com/?json&pagination=off get info about the gallery itself and the top-level albums, unpaginated

pagination has no effect on images.

Depth of album retrieval

Use the depth parameter to control the amount of information retrieved about descendant albums.

Albums:

  • http://mysite.com/myAlbum/?json&depth=0 get thumbnail info about myAlbum (no images, no subalbums)
  • http://mysite.com/myAlbum/?json&depth=1 get myAlbum and thumbnail info about its immediate subalbums
  • http://mysite.com/myAlbum/?json&depth=2 get myAlbum, its immediate subalbums, and thumbnail info about the subalbums' immediate subalbums
  • http://mysite.com/myAlbum/?json&depth=-1 get full information about myAlbum and ALL its descendants

The gallery itself:

  • http://mysite.com/?json&depth=0 get basic info about the gallery, but no albums
  • http://mysite.com/?json&depth=1 get thumbnail info about the top-level albums
  • http://mysite.com/?json&depth=2 get top level albums and thumbnail info about their children
  • http://mysite.com/?json&depth=-1 get EVERY ALBUM IN THE SYSTEM

If depth is omitted, it defaults to 1, meaning it returns thumbnail information about immediate child albums.

There is no maximum depth. You can go as deep as you want.

Use depth carefully! It can be very expensive to get a giant set of nested albums. I can't call this on my own root gallery of about 1000 albums and 25000 images because it times out.

depth has no effect on images and searches.

Statistics

If you have enabled the image_album_statistics plugin (it's included with Zenphoto), you can retrieve various statistics about your overall gallery or specific albums.

The gallery itself:

  • http://mysite.com/?json&latest_albums get the latest album in your gallery
  • http://mysite.com/?json&latest_albums&latest_images get the latest album and the latest image

Albums:

  • http://mysite.com/myAlbum/?json&latest_albums get myAlbum's latest subalbum

Supports the following stats:

  • Albums
    • popular_albums, latest_albums, latest_date_albums, latest_mtime_albums, latest_publishdate_albums, mostrated_albums, toprated_albums, latestupdated_albums, random_albums
  • Images
    • popular_images, latest_images, latest_date_images, latest_mtime_images, latest_publishdate_images, mostrated_images, toprated_images, random_images

Supports the following parameters:

  • count The number of albums or images to return. Defaults to 1.
  • threshold The minimum number of ratings (for rating options) or hits (for popular option) an album must have to be included in the list. Defaults to 0.
  • sort Takes either asc or desc. Whether to return items in ascending or descending order (e.g., most to least hits or least to most) Defaults to descending.
  • deep This only applies when getting albums, not the overall gallery. When true the stats will be measured across all descendant albums. Otherwise it will only measure the stats on the specific named album: image stats will only include images in the album and album stats will only include immedate child albums. Defaults to false.

Examples:

  • http://mysite.com/?json&latest_albums=count:3 get the 3 latest albums
  • http://mysite.com/?json&popular_albums=threshold:2 get the most popular subalbum, must have at least 2 views
  • http://mysite.com/?json&latest_albums=sort:asc get the oldest album in the gallery
  • http://mysite.com/myAlbum/?json&latest_albums=deep:true get the newest album at any depth under myAlbum

Join parameters with commas:

http://mysite.com/?json&popular_albums=count:3,sort:asc,threshold:2

If you just want to get statistics and not get anything else, the most efficient way is to ask for the gallery with depth=0:

http://mysite.com/?json&depth=0&popular_albums

Statistics can only be collected on gallery and album requests; they cannot be collected on image and search requests.

Localization

If your Zenphoto is in multilingual mode, you can access language-specific content:

  • Enable the official seo_locale plugin to allow switching the language via URL
  • http://mysite.com/<locale>/myAlbum/?json now gets JSON about myAlbum in that locale, if any language-specific content exists. Otherwise it gets content for the default language.
  • Example: http://mysite.com/de_DE/myAlbum/?json would get the German content

This principle works with all the URLs above.

Cross-domain AJAX

For security reasons it does not support AJAX requests from random domains. However, it does allow cross-domain AJAX from subdomains. For example, you can have zenphoto on mysite.com and your web app on app.mysite.com.