GiftRocket gift card API for node.js
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
.gitignore
LICENSE
Makefile
README.md
index.js
package.json

README.md

giftrocket-node

A node.js client library for the GiftRocket API.

Installation

$ npm install giftrocket

Getting started

All API requests require an access token. A sandbox access token is assigned upon signup through the GiftRocket Dashboard. Once you are ready to move to production, you will be assigned a production access token.

Authentication

var GiftRocket = require('giftrocket');

// Sandbox environment
var client = new GiftRocket("[SANDBOX_ACCESS_TOKEN]", "https://testflight.giftrocket.com");

// Production environment
var client = new GiftRocket("[PRODUCTION_ACCESS_TOKEN]", "https://www.giftrocket.com");

Orders

See API documentation for all Order options, including delivery_method. Use the FoundingSources resource to look up a valid method for your payment (i.e. credit card, ACH, etc).

// Create a new order, specifying your gift options
// as an array of objects.
client.createOrder({
  "funding_source_id": "QEW8P5NHEW95",
  "gifts": [
    {
      "amount": 40,
      "message": "Such a great way to show appreciation to others!",
      "catalog": ["Q24BD9EZ332JT", "OKMHM2X2OHYV"],
      "recipient": {
        "email": "giftrocket-api@quester.com",
        "name": "Eric Henderson",
        "delivery_method": "EMAIL"
      }
    }
  ]
}, function(err, results) {
  console.log(JSON.stringify(err, null, 2));
  console.log(JSON.stringify(results, null, 2));
});

// Return historical orders, optionally passing a starting offset for results.
client.getOrders({offset: 10}, function(err, results) {
  console.log(JSON.stringify(results, null, 2));
});

// Return a order by order_id
client.getOrder("[ORDER_ID]", function(err, result) {
  console.log(JSON.stringify(result, null, 2));
});

Funding Sources

Production funding sources must be added through the web dashboard. A sandbox funding source is provided during development.

// Retrieve a list of your funding sources (credit card, ach, etc).
client.getFundingSources({}, function(err, results) {
  console.log(JSON.stringify(results, null, 2));
});

Styles

A style defines the presentation of your gift. The styles endpoint returns an array of card designs.

client.getStyles({}, function(err, results) {
  console.log(JSON.stringify(results, null, 2));
});

Gifts

Retrieve a single or many historical gifts sent by your account.

client.getGifts({offset: 10}, function(err, results) {
  console.log(JSON.stringify(results, null, 2));
});

client.getGift("[GIFT_ID]", function(err, results) {
  console.log(JSON.stringify(results, null, 2));
});

Catalog

client.getCatalog(function(err, results) {
  console.log(JSON.stringify(results, null, 2));
});