npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

snowshoe-stamp-sdk

v3.0.3

Published

Node SDK Client for the Snowshoe API

Downloads

8

Readme

Overview

This is a sdk package that can be used in your Node.js code as a plugin to be able to transfer a properly encoded string that represents stamp points to SnowShoe servers and get a response with stamp information.

Installing

You can install snowshoe-stamp-sdk via the npm package.

$ npm install snowshoe-stamp-sdk

Getting Started

  1. To be able to use this SDK tool you need to create an app first. You can learn how to HERE

  2. Make sure you get the API Key that you will need to run requests. You can learn more about the API Keys HERE

  3. The stamp data passed to our servers is an array of x,y coordinates. These represent the touch points from the stamp that you are trying to get data for. If you are using our front-end jquery plugin (more info on this located HERE) to capture stamp touch point data, then you can just pass that data directly through for the request with no need to change.

Test App

Make a new javascript file named test.js to use. You will need to 'require' the snowshoe-stamp-sdk in the app. We will also use some mock data the represent the points here for testing and you will need your API Key also for testing. Here is a sample piece of code to use for testing. Copy and add this to the test.js file.

var Snowshoe = require('snowshoe-stamp-sdk');

var client = new Snowshoe.client('YOUR_API_KEY');
    var data = "[[264,172],[267,371],[242,286],[69,375],[66,221]]";

client.post(data, function(error, data) {
    if (error) {
        console.log(error);
    }
    else {
        console.log(data);
    }
});

After you save the file go to console and navigate to the folder the file is in. Run the file with:

node test.js

This should print out a status code of 200 and a JSON showing a "serial" of "DEVA". The whole JSON should look something like this:

{
  stamp: { serial: 'DEVA', customName: 'DEVA' },
  receipt: '0d8e3aa3-4a34-407c-95a7-db62acab2269',
  created: '2020-02-17T22:15:03.7571485Z'
}

The information returned here is the data about the stamp relating to the points and api key you sent in the request. For more info on stamp data requests and returns go HERE

More info

  • This sdk extension is made for simplistic retrieval of stamp data from our servers through the node.js language when your server uses this as it's primary code.
  • For more info on how to use our product visit: https://snowshoe.readme.io/v3.0/docs