Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Sensis API node.js client
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test-integration
test
.bob.json
.gitignore
.npmignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
avatar.jpg
package.json

README.md

Avatar

Build Status Dependencies Status Coverage Status Published Version
npm Badge

Sapi

Sapi is a Sensis API node.js client.

This is handy when you want to use Sensis API service from a Node.js application. Sapi module provides a chainable interface to set the endpoint parameters.

Tested with Sensis API version ob-20110511.

Installation

npm install sapi

or as a dependency in package.json file:

"dependencies": {
  "sapi": "x.y.z"
}

Usage

var Sapi = require('sapi'),
  sapi = new Sapi('apikey', {
    url: 'http://api.sensis.com.au/ob-20110511/test/',
    proxy: 'http://user:pass@proxy:8080'
  });

You can apply for Sensis API key from Sensis Developer Centre.

Parameters can then be chained to an endpoint:

sapi
  .param1('value1')
  .param2('value2')
  .param3('value3')
  .endpoint(function (err, result) {
    ...
  });

Search for restaurants in Melbourne:

sapi
  .query('restaurants')
  .location('Melbourne')
  .search(function (err, result) {
    ...
  });

Get listing details by ID:

sapi
  .query('12345')
  .getByListingId(function (err, result) {
    ...
  });

Retrieve categories metadata:

sapi
  .dataType('categories')
  .metadata(function (err, result) {
    ...
  });

Send report events:

sapi
  .userIp('192.1.2.3')
  .id('VyY2UiOi')
  .content('(03) 1234 5678')
  .report(function (err, result) {
    ...
  });

Endpoints

Check out Sensis API documentation for further details of the endpoints, a list of parameters, and response message structure:

Colophon

Developer's Guide

Build reports:

Articles:

Something went wrong with that request. Please try again.