Code samples and libraries

SDK/Client Libraries

APIMatic have set up a range of SDKs/Client Libraries for DigitalNZ's API that includes PHP, Javascript, Python, Ruby, Java, C#, and Objective C.

Javascript search widget for API v3

In-context search of content in DigitalNZ that can be embedded in web pages and blogs etc.

• Source code and resources for DigitalNZ search widget in a zipped archive (ZIP / 13KB). Also see the cut down version of the same code turned into an image display (ZIP / 13KB)

Python resources for API v3

• pyDnz - a Python module for consuming the DigitalNZ API.
• A video tutorial demonstrating how to create simple search application with the DigitalNZ API.

Deprecated code samples for API v1 and v2

The following code samples were written for the depreciated versions 1 and 2 of the DigitalNZ API. The current DigitalNZ API is version 3.

iOS (Objective C) iPhone/iPad app (old)

A simple app for searching DigitalNZ from your iPhone, iPad or iPod Touch.

• Source code has been released under an MIT License and is available from GitHub
• Additional code libraries and resources for the app are in a zipped archive (ZIP / 0.8MB)

PHP Demonstration Website (old)

A Picture Show website built on the DigitalNZ Search API.

• The blog post with full source code - Elliott Young

PHP Drupal module (old)

Module to integrate DigitalNZ search with Drupal CMS.

• Source code for DigitalNZ Drupal module - Jonathan Hunt

PHP Moodle search block - François Marier (old) 

Plugin to allow teachers to provide their students with an easy way of using the DigitalNZ search engine from within a Moodle course page.

• Moodle Search Block web page

PHP Moodle embedded resource - François Marier (old)

Plugin to allow teachers to provide their students with links to resources indexed by DigitalNZ.

• Moodle embedded resource web page

Python module - Mark Matienzo (old)

A Python module to interact with the DigitalNZ API. Shorthand way to make requests that then grabs JSON responses and translates to a Python object.

• Source code for python module

Ruby Gem for DigitalNZ - James Harton (old)

Note that some components such as the DigitalNZ record lookup and date were not added.

• Source code for Ruby Gem

Ruby DigitalNZ client library - Boost (old)

This library uses nokogiri for speedily parsing the XML.

• Examples

Ruby Kete's External Search Sources - Kete/Katipo/Auckland City Library (old)

• Source code for Kete External Search Sources

Ruby Geoparsing DigitalNZ - Gordon Anderson (old)

• Source code