{"_id":"5e332aff5fe1cd3965383581","excerpt":"Welcome to the home of SnowShoe V3 Documentation\n*Last updated February 25, 2020*","link_url":"","version":"5e332aff5fe1cd3965383588","createdAt":"2016-02-27T00:51:12.646Z","order":0,"slug":"what-is-snowshoe","title":"What is SnowShoe?","user":"5509cfc1e463aa3d000dd34a","category":"5e332aff5fe1cd3965383567","hidden":false,"link_external":false,"sync_unique":"","type":"basic","updates":[],"__v":7,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","params":[]},"body":"**Unlock a better experience**\nSnowShoe is uniquely focused on mobile authentication utilizing capacitive touch stamps. We are revolutionizing the way mobile tickets, vouchers, and loyalty points are validated at the point of presence – where digital meets the real world. Secure, battery-free, and easy to integrate.\n\n**Native Apps and Mobile Web**\nStamps work in native iOS and Android applications in addition to mobile websites.\n\n**Every Stamp is Unique**\nStamps are uniquely identifiable, making tracking users, redemptions and engagement easier than ever.\n\n**No Batteries**\nNo batteries, wires or antennas. SnowShoe stamps are built to last without costly overhead.\n\n**Online or Offline**\nStamps can work offline within a native application when wireless service is unavailable.\n\n**How it Works**\nStamps work using the capacitance of your body and touchscreen. When a stamp comes into full contact with the screen, the mobile device sees \"5-fingers\" in a very specific pattern. We use this pattern to authenticate which stamp is in-use and then return this information to you. At that point, you make the magic happen!\n\nYour body is an electrical conductor and provides most of the energy for the interaction. __*It's important that you hold the phone while stamping for best results.*__\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/CUADYXqqTNSNbClEvaZe_how_snowshoe_works.jpg\",\n        \"how_snowshoe_works.jpg\",\n        \"1280\",\n        \"400\",\n        \"#d79a8b\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nSnowShoe software is easy to integrate. We love easy-to-implement, well documented APIs. Our aim is to provided you concise, relevant documentation to get you and your team up and stamping with SnowShoe with as little effort as possible.\n\nWe would love to hear from you. Please [contact us](doc:contact-email) with any comments, questions, or suggestions.","githubsync":"","project":"55087b0f6065ed17002643ce","isReference":false,"next":{"description":"","pages":[]},"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

What is SnowShoe?

Welcome to the home of SnowShoe V3 Documentation *Last updated February 25, 2020*

**Unlock a better experience** SnowShoe is uniquely focused on mobile authentication utilizing capacitive touch stamps. We are revolutionizing the way mobile tickets, vouchers, and loyalty points are validated at the point of presence – where digital meets the real world. Secure, battery-free, and easy to integrate. **Native Apps and Mobile Web** Stamps work in native iOS and Android applications in addition to mobile websites. **Every Stamp is Unique** Stamps are uniquely identifiable, making tracking users, redemptions and engagement easier than ever. **No Batteries** No batteries, wires or antennas. SnowShoe stamps are built to last without costly overhead. **Online or Offline** Stamps can work offline within a native application when wireless service is unavailable. **How it Works** Stamps work using the capacitance of your body and touchscreen. When a stamp comes into full contact with the screen, the mobile device sees "5-fingers" in a very specific pattern. We use this pattern to authenticate which stamp is in-use and then return this information to you. At that point, you make the magic happen! Your body is an electrical conductor and provides most of the energy for the interaction. __*It's important that you hold the phone while stamping for best results.*__ [block:image] { "images": [ { "image": [ "https://files.readme.io/CUADYXqqTNSNbClEvaZe_how_snowshoe_works.jpg", "how_snowshoe_works.jpg", "1280", "400", "#d79a8b", "" ] } ] } [/block] SnowShoe software is easy to integrate. We love easy-to-implement, well documented APIs. Our aim is to provided you concise, relevant documentation to get you and your team up and stamping with SnowShoe with as little effort as possible. We would love to hear from you. Please [contact us](doc:contact-email) with any comments, questions, or suggestions.
**Unlock a better experience** SnowShoe is uniquely focused on mobile authentication utilizing capacitive touch stamps. We are revolutionizing the way mobile tickets, vouchers, and loyalty points are validated at the point of presence – where digital meets the real world. Secure, battery-free, and easy to integrate. **Native Apps and Mobile Web** Stamps work in native iOS and Android applications in addition to mobile websites. **Every Stamp is Unique** Stamps are uniquely identifiable, making tracking users, redemptions and engagement easier than ever. **No Batteries** No batteries, wires or antennas. SnowShoe stamps are built to last without costly overhead. **Online or Offline** Stamps can work offline within a native application when wireless service is unavailable. **How it Works** Stamps work using the capacitance of your body and touchscreen. When a stamp comes into full contact with the screen, the mobile device sees "5-fingers" in a very specific pattern. We use this pattern to authenticate which stamp is in-use and then return this information to you. At that point, you make the magic happen! Your body is an electrical conductor and provides most of the energy for the interaction. __*It's important that you hold the phone while stamping for best results.*__ [block:image] { "images": [ { "image": [ "https://files.readme.io/CUADYXqqTNSNbClEvaZe_how_snowshoe_works.jpg", "how_snowshoe_works.jpg", "1280", "400", "#d79a8b", "" ] } ] } [/block] SnowShoe software is easy to integrate. We love easy-to-implement, well documented APIs. Our aim is to provided you concise, relevant documentation to get you and your team up and stamping with SnowShoe with as little effort as possible. We would love to hear from you. Please [contact us](doc:contact-email) with any comments, questions, or suggestions.
{"_id":"5e332aff5fe1cd3965383580","__v":4,"githubsync":"","order":2,"project":"55087b0f6065ed17002643ce","slug":"whats-new","user":"5509cfc1e463aa3d000dd34a","createdAt":"2016-02-27T00:46:40.911Z","link_external":false,"link_url":"","updates":[],"api":{"url":"","auth":"required","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"category":"5e332aff5fe1cd3965383567","excerpt":"","hidden":false,"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"We have some exciting news to share! Our Product Team has been hard at work developing a major upgrade to our stamping service platform. V3 is a complete upgrade to the SnowShoe Platform and initially includes the following:\\n  * Improved developer interface and user experience\\n  * Improved analytics including individual stamp data\\n  * Updated global cloud infrastructure\\n  * New SDKs for all mobile deployment scenarios\\n\\nV3 is a brand new and built from the ground up on Microsoft Azure with modern cloud technologies, best practices, and security at its core. We even removed the \\\"beta\\\" from the URL!\\n\\nTo login or create an account in V3, go to [https://app.snowshoestamp.com/Account/Login](https://app.snowshoestamp.com/Account/Login).\\n\\nWe plan to continue developing and rolling out enhanced features in V3 - so watch for more improvements coming later in 2020.\",\n  \"title\": \"SnowShoe has released V3 of our cloud platform!\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If you are an existing V2 client, we will still be supporting your applications and configuration for the foreseeable future and you will still find your applications in the V2 portal ([https://beta.snowshoestamp.com/accounts/login/](https://beta.snowshoestamp.com/accounts/login/)).\\n\\nIf you are eager to take advantage of the new features in V3, please take a look at our [Migrate to V3](doc:migrate-to-v3) guide.\\n\\nNew user accounts will now only be created in V3 (if you need a new V2 user account, please [contact us](doc:contact-email) for assistance).\",\n  \"title\": \"Existing V2 Clients\"\n}\n[/block]","sync_unique":"","title":"What's New","type":"basic","version":"5e332aff5fe1cd3965383588","isReference":false,"next":{"description":"","pages":[]},"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

What's New


[block:callout] { "type": "success", "body": "We have some exciting news to share! Our Product Team has been hard at work developing a major upgrade to our stamping service platform. V3 is a complete upgrade to the SnowShoe Platform and initially includes the following:\n * Improved developer interface and user experience\n * Improved analytics including individual stamp data\n * Updated global cloud infrastructure\n * New SDKs for all mobile deployment scenarios\n\nV3 is a brand new and built from the ground up on Microsoft Azure with modern cloud technologies, best practices, and security at its core. We even removed the \"beta\" from the URL!\n\nTo login or create an account in V3, go to [https://app.snowshoestamp.com/Account/Login](https://app.snowshoestamp.com/Account/Login).\n\nWe plan to continue developing and rolling out enhanced features in V3 - so watch for more improvements coming later in 2020.", "title": "SnowShoe has released V3 of our cloud platform!" } [/block] [block:callout] { "type": "info", "body": "If you are an existing V2 client, we will still be supporting your applications and configuration for the foreseeable future and you will still find your applications in the V2 portal ([https://beta.snowshoestamp.com/accounts/login/](https://beta.snowshoestamp.com/accounts/login/)).\n\nIf you are eager to take advantage of the new features in V3, please take a look at our [Migrate to V3](doc:migrate-to-v3) guide.\n\nNew user accounts will now only be created in V3 (if you need a new V2 user account, please [contact us](doc:contact-email) for assistance).", "title": "Existing V2 Clients" } [/block]
[block:callout] { "type": "success", "body": "We have some exciting news to share! Our Product Team has been hard at work developing a major upgrade to our stamping service platform. V3 is a complete upgrade to the SnowShoe Platform and initially includes the following:\n * Improved developer interface and user experience\n * Improved analytics including individual stamp data\n * Updated global cloud infrastructure\n * New SDKs for all mobile deployment scenarios\n\nV3 is a brand new and built from the ground up on Microsoft Azure with modern cloud technologies, best practices, and security at its core. We even removed the \"beta\" from the URL!\n\nTo login or create an account in V3, go to [https://app.snowshoestamp.com/Account/Login](https://app.snowshoestamp.com/Account/Login).\n\nWe plan to continue developing and rolling out enhanced features in V3 - so watch for more improvements coming later in 2020.", "title": "SnowShoe has released V3 of our cloud platform!" } [/block] [block:callout] { "type": "info", "body": "If you are an existing V2 client, we will still be supporting your applications and configuration for the foreseeable future and you will still find your applications in the V2 portal ([https://beta.snowshoestamp.com/accounts/login/](https://beta.snowshoestamp.com/accounts/login/)).\n\nIf you are eager to take advantage of the new features in V3, please take a look at our [Migrate to V3](doc:migrate-to-v3) guide.\n\nNew user accounts will now only be created in V3 (if you need a new V2 user account, please [contact us](doc:contact-email) for assistance).", "title": "Existing V2 Clients" } [/block]
{"_id":"5e332aff5fe1cd3965383573","createdAt":"2015-03-25T22:56:55.352Z","link_external":false,"link_url":"","project":"55087b0f6065ed17002643ce","updates":[],"version":"5e332aff5fe1cd3965383588","type":"basic","__v":33,"api":{"auth":"required","params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":""},"category":"5e332aff5fe1cd3965383567","excerpt":"Here is a list of the SnowShoe maintained libraries. These make pages in your application stampable.\n\n**For web applications**, you'll need to use both our \n   1. **_Front-end library_** (to recognize the stamp and submit this data to your app's backend)\n   2. **_One of our server-side libraries_** (to package this data up and submit it to the SnowShoe API for recognition).\n\n**For native applications**, you'll just use **_one of our Native mobile libraries_**. These contain the code to both recognize data from the stamp and submit this data to the SnowShoe API for recognition.\n\nAdditional SDK documentation can be found in each library's GitHub readme file.","githubsync":"","slug":"maintained-libraries","body":"**Front-end**\n- [SnowShoe jQuery Module](https://github.com/snowshoestamp/snowshoe-sdk-jquery)\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"SnowShoe CDN\",\n  \"body\": \"SnowShoe jQuery Module:\\n-- v3.0.4: https://cdn.snowshoestamp.com/snowshoe-jquery/3.0.4/jquery.snowshoe.js\\n-- v3.0.4 minified: https://cdn.snowshoestamp.com/snowshoe-jquery/3.0.4/jquery.snowshoe.min.js\"\n}\n[/block]\n**Server-side**\n - [Node.js SDK](https://github.com/snowshoestamp/snowshoe-sdk-node/)\n\n - [Python SDK](https://github.com/snowshoestamp/snowshoe-sdk-python)\n\n - [PHP SDK](https://github.com/snowshoestamp/snowshoe-sdk-php)\n\n - [Ruby SDK](https://github.com/snowshoestamp/snowshoe-sdk-ruby)\n\n- [Java SDK](https://github.com/snowshoestamp/snowshoe-sdk-java)\n\n**Native**\n  - [iOS SDK](https://s3.amazonaws.com/downloads.snowshoestamp.com/sdk/stampSDK_iOS-v3.1.2.zip) v3.1.2 (1/25/2021)\n\n  - [Android SDK](https://s3.amazonaws.com/downloads.snowshoestamp.com/sdk/stampSDK_Android-v3.1.1.zip) v3.1.1 (1/07/2021)","isReference":false,"order":3,"sync_unique":"","user":"5509cfc1e463aa3d000dd34a","hidden":false,"title":"Libraries","next":{"description":"","pages":[]},"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Libraries

Here is a list of the SnowShoe maintained libraries. These make pages in your application stampable. **For web applications**, you'll need to use both our 1. **_Front-end library_** (to recognize the stamp and submit this data to your app's backend) 2. **_One of our server-side libraries_** (to package this data up and submit it to the SnowShoe API for recognition). **For native applications**, you'll just use **_one of our Native mobile libraries_**. These contain the code to both recognize data from the stamp and submit this data to the SnowShoe API for recognition. Additional SDK documentation can be found in each library's GitHub readme file.

**Front-end** - [SnowShoe jQuery Module](https://github.com/snowshoestamp/snowshoe-sdk-jquery) [block:callout] { "type": "info", "title": "SnowShoe CDN", "body": "SnowShoe jQuery Module:\n-- v3.0.4: https://cdn.snowshoestamp.com/snowshoe-jquery/3.0.4/jquery.snowshoe.js\n-- v3.0.4 minified: https://cdn.snowshoestamp.com/snowshoe-jquery/3.0.4/jquery.snowshoe.min.js" } [/block] **Server-side** - [Node.js SDK](https://github.com/snowshoestamp/snowshoe-sdk-node/) - [Python SDK](https://github.com/snowshoestamp/snowshoe-sdk-python) - [PHP SDK](https://github.com/snowshoestamp/snowshoe-sdk-php) - [Ruby SDK](https://github.com/snowshoestamp/snowshoe-sdk-ruby) - [Java SDK](https://github.com/snowshoestamp/snowshoe-sdk-java) **Native** - [iOS SDK](https://s3.amazonaws.com/downloads.snowshoestamp.com/sdk/stampSDK_iOS-v3.1.2.zip) v3.1.2 (1/25/2021) - [Android SDK](https://s3.amazonaws.com/downloads.snowshoestamp.com/sdk/stampSDK_Android-v3.1.1.zip) v3.1.1 (1/07/2021)
**Front-end** - [SnowShoe jQuery Module](https://github.com/snowshoestamp/snowshoe-sdk-jquery) [block:callout] { "type": "info", "title": "SnowShoe CDN", "body": "SnowShoe jQuery Module:\n-- v3.0.4: https://cdn.snowshoestamp.com/snowshoe-jquery/3.0.4/jquery.snowshoe.js\n-- v3.0.4 minified: https://cdn.snowshoestamp.com/snowshoe-jquery/3.0.4/jquery.snowshoe.min.js" } [/block] **Server-side** - [Node.js SDK](https://github.com/snowshoestamp/snowshoe-sdk-node/) - [Python SDK](https://github.com/snowshoestamp/snowshoe-sdk-python) - [PHP SDK](https://github.com/snowshoestamp/snowshoe-sdk-php) - [Ruby SDK](https://github.com/snowshoestamp/snowshoe-sdk-ruby) - [Java SDK](https://github.com/snowshoestamp/snowshoe-sdk-java) **Native** - [iOS SDK](https://s3.amazonaws.com/downloads.snowshoestamp.com/sdk/stampSDK_iOS-v3.1.2.zip) v3.1.2 (1/25/2021) - [Android SDK](https://s3.amazonaws.com/downloads.snowshoestamp.com/sdk/stampSDK_Android-v3.1.1.zip) v3.1.1 (1/07/2021)
{"_id":"5e4ad838e2079a0154c6aa37","project":"55087b0f6065ed17002643ce","version":"5e332aff5fe1cd3965383588","category":"5e332aff5fe1cd396538356c","user":"5509cfc1e463aa3d000dd34a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2020-02-17T18:15:20.174Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:api-header]\n{\n  \"title\": \"Create an Account\"\n}\n[/block]\nGo to https://app.snowshoestamp.com/Account/Login and click “Sign Up.” Fill out the form to create your account.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d60e231-Screen_Shot_2020-01-29_at_12.08.39_PM.png\",\n        \"Screen Shot 2020-01-29 at 12.08.39 PM.png\",\n        1040,\n        1220,\n        \"#047cfc\"\n      ],\n      \"caption\": \"\",\n      \"sizing\": \"smart\",\n      \"border\": true\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Create an Application\"\n}\n[/block]\nOnce you have created your account and logged into the SnowShoe Client Portal, you should be taken to the portal home page.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e8dff29-Screen_Shot_2020-01-29_at_12.13.01_PM.png\",\n        \"Screen Shot 2020-01-29 at 12.13.01 PM.png\",\n        2310,\n        1020,\n        \"#057cfb\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\nClick “New App,” fill in the details of your app, and click “Create App.”\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/82e4c18-Screen_Shot_2020-01-29_at_12.14.05_PM.png\",\n        \"Screen Shot 2020-01-29 at 12.14.05 PM.png\",\n        1012,\n        806,\n        \"#f2f2f2\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Get API Keys\"\n}\n[/block]\nOnce you have created your app, click on it in the Applications Table at the bottom of the portal home page. Once you are in the application, click on the “Settings” tab. There you will find your API Keys.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/8bd0047-Screen_Shot_2020-02-17_at_10.24.19_AM.png\",\n        \"Screen Shot 2020-02-17 at 10.24.19 AM.png\",\n        1838,\n        1146,\n        \"#afbfb4\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\nThe API Keys are what you will use in your client application whenever you make a request to the SnowShoe platform. See [API Keys](doc:api-keys) for more information.","excerpt":"Follow the below steps to get started on the SnowShoe platform.","slug":"part-1-create-a-snowshoe-application","type":"basic","title":"Part 1: Create a SnowShoe Application","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Part 1: Create a SnowShoe Application

Follow the below steps to get started on the SnowShoe platform.

[block:api-header] { "title": "Create an Account" } [/block] Go to https://app.snowshoestamp.com/Account/Login and click “Sign Up.” Fill out the form to create your account. [block:image] { "images": [ { "image": [ "https://files.readme.io/d60e231-Screen_Shot_2020-01-29_at_12.08.39_PM.png", "Screen Shot 2020-01-29 at 12.08.39 PM.png", 1040, 1220, "#047cfc" ], "caption": "", "sizing": "smart", "border": true } ] } [/block] [block:api-header] { "title": "Create an Application" } [/block] Once you have created your account and logged into the SnowShoe Client Portal, you should be taken to the portal home page. [block:image] { "images": [ { "image": [ "https://files.readme.io/e8dff29-Screen_Shot_2020-01-29_at_12.13.01_PM.png", "Screen Shot 2020-01-29 at 12.13.01 PM.png", 2310, 1020, "#057cfb" ], "border": true } ] } [/block] Click “New App,” fill in the details of your app, and click “Create App.” [block:image] { "images": [ { "image": [ "https://files.readme.io/82e4c18-Screen_Shot_2020-01-29_at_12.14.05_PM.png", "Screen Shot 2020-01-29 at 12.14.05 PM.png", 1012, 806, "#f2f2f2" ], "border": true } ] } [/block] [block:api-header] { "title": "Get API Keys" } [/block] Once you have created your app, click on it in the Applications Table at the bottom of the portal home page. Once you are in the application, click on the “Settings” tab. There you will find your API Keys. [block:image] { "images": [ { "image": [ "https://files.readme.io/8bd0047-Screen_Shot_2020-02-17_at_10.24.19_AM.png", "Screen Shot 2020-02-17 at 10.24.19 AM.png", 1838, 1146, "#afbfb4" ], "border": true } ] } [/block] The API Keys are what you will use in your client application whenever you make a request to the SnowShoe platform. See [API Keys](doc:api-keys) for more information.
[block:api-header] { "title": "Create an Account" } [/block] Go to https://app.snowshoestamp.com/Account/Login and click “Sign Up.” Fill out the form to create your account. [block:image] { "images": [ { "image": [ "https://files.readme.io/d60e231-Screen_Shot_2020-01-29_at_12.08.39_PM.png", "Screen Shot 2020-01-29 at 12.08.39 PM.png", 1040, 1220, "#047cfc" ], "caption": "", "sizing": "smart", "border": true } ] } [/block] [block:api-header] { "title": "Create an Application" } [/block] Once you have created your account and logged into the SnowShoe Client Portal, you should be taken to the portal home page. [block:image] { "images": [ { "image": [ "https://files.readme.io/e8dff29-Screen_Shot_2020-01-29_at_12.13.01_PM.png", "Screen Shot 2020-01-29 at 12.13.01 PM.png", 2310, 1020, "#057cfb" ], "border": true } ] } [/block] Click “New App,” fill in the details of your app, and click “Create App.” [block:image] { "images": [ { "image": [ "https://files.readme.io/82e4c18-Screen_Shot_2020-01-29_at_12.14.05_PM.png", "Screen Shot 2020-01-29 at 12.14.05 PM.png", 1012, 806, "#f2f2f2" ], "border": true } ] } [/block] [block:api-header] { "title": "Get API Keys" } [/block] Once you have created your app, click on it in the Applications Table at the bottom of the portal home page. Once you are in the application, click on the “Settings” tab. There you will find your API Keys. [block:image] { "images": [ { "image": [ "https://files.readme.io/8bd0047-Screen_Shot_2020-02-17_at_10.24.19_AM.png", "Screen Shot 2020-02-17 at 10.24.19 AM.png", 1838, 1146, "#afbfb4" ], "border": true } ] } [/block] The API Keys are what you will use in your client application whenever you make a request to the SnowShoe platform. See [API Keys](doc:api-keys) for more information.
{"_id":"5e4c8050d316fb00626452ca","project":"55087b0f6065ed17002643ce","version":"5e332aff5fe1cd3965383588","category":"5e332aff5fe1cd396538356c","user":"5509cfc1e463aa3d000dd34a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2020-02-19T00:24:48.009Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Stampable Mobile Apps\",\n  \"body\": \"To add a stampable screen to your mobile app, check out the GitHub project readme files for the iOS and Android SDKs in [Libraries](doc:maintained-libraries).\"\n}\n[/block]\n##Making an HTML Stamp Screen\nIf you would like to make an existing page \"stampable,\" you just need to implement our [jQuery plugin](doc:maintained-libraries). Your workflow will look like the following:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/4f1877f-SSS_API_DIAGRAM_customer-hosted_stamp_screen.png\",\n        \"SSS_API_DIAGRAM_customer-hosted_stamp_screen.png\",\n        1416,\n        753,\n        \"#81cdec\"\n      ]\n    }\n  ]\n}\n[/block]\nAt the bottom of any page you want to make \"stampable\", create an object with initialization data and include the Snowshoe jQuery module. `$.snowshoe` will construct the necessary touch event listener and client to submit stamp data to your backend.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<script>\\nvar stampScreenInitData = {\\n  \\\"postUrl\\\": \\\"http://mydomain.com/stampscreen\\\",\\n  // element id of what you want to be stampable\\n  // this can be on a canvas, div or the body\\n  \\\"stampScreenElmId\\\": \\\"stamp-screen\\\",\\n  \\\"preventScrolling\\\": true, // prevent scrolling when stamping the stamp area\\n  \\\"preventZooming\\\": true, // prevent zooming when stamping the stamp area\\n  \\\"success\\\": function(response){\\n    // handle success\\n    console.log(\\\"Success!\\\");\\n  },\\n  \\\"error\\\": function(response){\\n    // handle failure\\n    console.log(\\\" :-( \\\");\\n  }\\n}\\n</script>\\n<script src=\\\"jquery.snowshoe.js\\\"></script>\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\nThis module will set your configured `stampScreenElmId` to be \"stampable\" and will submit an AJAX request to the configured `postUrl` whenever it is stamped. Your backend server will need to implement one of our server-side [libraries](doc:maintained-libraries) to relay the request to our API.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Addtional configuration options\",\n  \"body\": \"For additional configuration options and documentation on how to implement our jQuery module, check out the documentation on our GitHub found in [Libraries](doc:maintained-libraries).\"\n}\n[/block]\n##Stamping directly to our API\nYou can also configure your website to call our API directly from the jQuery module. This enables you to validate stamp events without needing a backend server of your own.\n\nAll you need to do is set the `postUrl` directly to our [Stamp API](doc:stamp) and set the `apiKey` to one of your [API keys](doc:client-portal-api-keys).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<script>\\n  var stampScreenInitData = {\\n    \\\"postUrl\\\": \\\"https://api.snowshoestamp.com/v3/stamp\\\",\\n    \\\"stampScreenElmId\\\": \\\"stamp-screen\\\",\\n    \\\"apiKey\\\": \\\"YOUR_SNOWSHOE_API_KEY\\\"\\n    // additional configuration as needed\\n  }\\n</script>\\n<script src=\\\"jquery.snowshoe.js\\\"></script>\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Stamping our API directly\",\n  \"body\": \"If you choose to call our API directly from our jQuery module, you will need to implement additional front-end logic to handle the results. Depending on the function of your application, decisions will need to be made to validate and associate stamp serial numbers (or custom names) to an appropriate action for the user.\"\n}\n[/block]","excerpt":"A stamp screen can be provided on a mobile device via a webpage or a mobile app","slug":"part-2-stamp-screen","type":"basic","title":"Part 2: Stamp Screen","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Part 2: Stamp Screen

A stamp screen can be provided on a mobile device via a webpage or a mobile app

[block:callout] { "type": "info", "title": "Stampable Mobile Apps", "body": "To add a stampable screen to your mobile app, check out the GitHub project readme files for the iOS and Android SDKs in [Libraries](doc:maintained-libraries)." } [/block] ##Making an HTML Stamp Screen If you would like to make an existing page "stampable," you just need to implement our [jQuery plugin](doc:maintained-libraries). Your workflow will look like the following: [block:image] { "images": [ { "image": [ "https://files.readme.io/4f1877f-SSS_API_DIAGRAM_customer-hosted_stamp_screen.png", "SSS_API_DIAGRAM_customer-hosted_stamp_screen.png", 1416, 753, "#81cdec" ] } ] } [/block] At the bottom of any page you want to make "stampable", create an object with initialization data and include the Snowshoe jQuery module. `$.snowshoe` will construct the necessary touch event listener and client to submit stamp data to your backend. [block:code] { "codes": [ { "code": "<script>\nvar stampScreenInitData = {\n \"postUrl\": \"http://mydomain.com/stampscreen\",\n // element id of what you want to be stampable\n // this can be on a canvas, div or the body\n \"stampScreenElmId\": \"stamp-screen\",\n \"preventScrolling\": true, // prevent scrolling when stamping the stamp area\n \"preventZooming\": true, // prevent zooming when stamping the stamp area\n \"success\": function(response){\n // handle success\n console.log(\"Success!\");\n },\n \"error\": function(response){\n // handle failure\n console.log(\" :-( \");\n }\n}\n</script>\n<script src=\"jquery.snowshoe.js\"></script>", "language": "html" } ] } [/block] This module will set your configured `stampScreenElmId` to be "stampable" and will submit an AJAX request to the configured `postUrl` whenever it is stamped. Your backend server will need to implement one of our server-side [libraries](doc:maintained-libraries) to relay the request to our API. [block:callout] { "type": "info", "title": "Addtional configuration options", "body": "For additional configuration options and documentation on how to implement our jQuery module, check out the documentation on our GitHub found in [Libraries](doc:maintained-libraries)." } [/block] ##Stamping directly to our API You can also configure your website to call our API directly from the jQuery module. This enables you to validate stamp events without needing a backend server of your own. All you need to do is set the `postUrl` directly to our [Stamp API](doc:stamp) and set the `apiKey` to one of your [API keys](doc:client-portal-api-keys). [block:code] { "codes": [ { "code": "<script>\n var stampScreenInitData = {\n \"postUrl\": \"https://api.snowshoestamp.com/v3/stamp\",\n \"stampScreenElmId\": \"stamp-screen\",\n \"apiKey\": \"YOUR_SNOWSHOE_API_KEY\"\n // additional configuration as needed\n }\n</script>\n<script src=\"jquery.snowshoe.js\"></script>", "language": "html" } ] } [/block] [block:callout] { "type": "info", "title": "Stamping our API directly", "body": "If you choose to call our API directly from our jQuery module, you will need to implement additional front-end logic to handle the results. Depending on the function of your application, decisions will need to be made to validate and associate stamp serial numbers (or custom names) to an appropriate action for the user." } [/block]
[block:callout] { "type": "info", "title": "Stampable Mobile Apps", "body": "To add a stampable screen to your mobile app, check out the GitHub project readme files for the iOS and Android SDKs in [Libraries](doc:maintained-libraries)." } [/block] ##Making an HTML Stamp Screen If you would like to make an existing page "stampable," you just need to implement our [jQuery plugin](doc:maintained-libraries). Your workflow will look like the following: [block:image] { "images": [ { "image": [ "https://files.readme.io/4f1877f-SSS_API_DIAGRAM_customer-hosted_stamp_screen.png", "SSS_API_DIAGRAM_customer-hosted_stamp_screen.png", 1416, 753, "#81cdec" ] } ] } [/block] At the bottom of any page you want to make "stampable", create an object with initialization data and include the Snowshoe jQuery module. `$.snowshoe` will construct the necessary touch event listener and client to submit stamp data to your backend. [block:code] { "codes": [ { "code": "<script>\nvar stampScreenInitData = {\n \"postUrl\": \"http://mydomain.com/stampscreen\",\n // element id of what you want to be stampable\n // this can be on a canvas, div or the body\n \"stampScreenElmId\": \"stamp-screen\",\n \"preventScrolling\": true, // prevent scrolling when stamping the stamp area\n \"preventZooming\": true, // prevent zooming when stamping the stamp area\n \"success\": function(response){\n // handle success\n console.log(\"Success!\");\n },\n \"error\": function(response){\n // handle failure\n console.log(\" :-( \");\n }\n}\n</script>\n<script src=\"jquery.snowshoe.js\"></script>", "language": "html" } ] } [/block] This module will set your configured `stampScreenElmId` to be "stampable" and will submit an AJAX request to the configured `postUrl` whenever it is stamped. Your backend server will need to implement one of our server-side [libraries](doc:maintained-libraries) to relay the request to our API. [block:callout] { "type": "info", "title": "Addtional configuration options", "body": "For additional configuration options and documentation on how to implement our jQuery module, check out the documentation on our GitHub found in [Libraries](doc:maintained-libraries)." } [/block] ##Stamping directly to our API You can also configure your website to call our API directly from the jQuery module. This enables you to validate stamp events without needing a backend server of your own. All you need to do is set the `postUrl` directly to our [Stamp API](doc:stamp) and set the `apiKey` to one of your [API keys](doc:client-portal-api-keys). [block:code] { "codes": [ { "code": "<script>\n var stampScreenInitData = {\n \"postUrl\": \"https://api.snowshoestamp.com/v3/stamp\",\n \"stampScreenElmId\": \"stamp-screen\",\n \"apiKey\": \"YOUR_SNOWSHOE_API_KEY\"\n // additional configuration as needed\n }\n</script>\n<script src=\"jquery.snowshoe.js\"></script>", "language": "html" } ] } [/block] [block:callout] { "type": "info", "title": "Stamping our API directly", "body": "If you choose to call our API directly from our jQuery module, you will need to implement additional front-end logic to handle the results. Depending on the function of your application, decisions will need to be made to validate and associate stamp serial numbers (or custom names) to an appropriate action for the user." } [/block]
{"_id":"5e4c81c579cfc00133f24c47","project":"55087b0f6065ed17002643ce","version":"5e332aff5fe1cd3965383588","category":"5e332aff5fe1cd396538356c","user":"5509cfc1e463aa3d000dd34a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2020-02-19T00:31:01.491Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"##Sending the Request to the API\nThere are a number of server-side [libraries](doc:maintained-libraries) available to relay stamp events to our API. The readme files located in the respective GitHub repositories will provide more details on how to implement the SDK of your choice.\n\nIf you choose to build your own, here are a couple of references you might be interested in:\n* [Stamp API Reference](doc:stamp)\n* [Testing with CURL](doc:testing-with-curl)\n* [Testing with Postman](doc:testing-with-postman) \n\n##Handling the API Response\nA successful [stamp response](doc:stamp) will include the `serial` number written on the side of the stamp and the `customName` configured in the [Stamp Settings](doc:client-portal-stamp) of the Client Portal. Using one of these values, you will make a decision on how to proceed with your user.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"stamp\\\": {\\n    \\\"serial\\\": \\\"DEVA\\\",\\n    \\\"customName\\\": \\\"DEVA\\\"\\n  },\\n  \\\"receipt\\\": \\\"14b565f2-0bbd-41e7-acba-67b948e4b076\\\",\\n  \\\"created\\\": \\\"2020-02-15T00:45:04.7639213Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"API Response\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"part-3-api-request","type":"basic","title":"Part 3: API Request","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Part 3: API Request


##Sending the Request to the API There are a number of server-side [libraries](doc:maintained-libraries) available to relay stamp events to our API. The readme files located in the respective GitHub repositories will provide more details on how to implement the SDK of your choice. If you choose to build your own, here are a couple of references you might be interested in: * [Stamp API Reference](doc:stamp) * [Testing with CURL](doc:testing-with-curl) * [Testing with Postman](doc:testing-with-postman) ##Handling the API Response A successful [stamp response](doc:stamp) will include the `serial` number written on the side of the stamp and the `customName` configured in the [Stamp Settings](doc:client-portal-stamp) of the Client Portal. Using one of these values, you will make a decision on how to proceed with your user. [block:code] { "codes": [ { "code": "{\n \"stamp\": {\n \"serial\": \"DEVA\",\n \"customName\": \"DEVA\"\n },\n \"receipt\": \"14b565f2-0bbd-41e7-acba-67b948e4b076\",\n \"created\": \"2020-02-15T00:45:04.7639213Z\"\n}", "language": "json", "name": "API Response" } ] } [/block]
##Sending the Request to the API There are a number of server-side [libraries](doc:maintained-libraries) available to relay stamp events to our API. The readme files located in the respective GitHub repositories will provide more details on how to implement the SDK of your choice. If you choose to build your own, here are a couple of references you might be interested in: * [Stamp API Reference](doc:stamp) * [Testing with CURL](doc:testing-with-curl) * [Testing with Postman](doc:testing-with-postman) ##Handling the API Response A successful [stamp response](doc:stamp) will include the `serial` number written on the side of the stamp and the `customName` configured in the [Stamp Settings](doc:client-portal-stamp) of the Client Portal. Using one of these values, you will make a decision on how to proceed with your user. [block:code] { "codes": [ { "code": "{\n \"stamp\": {\n \"serial\": \"DEVA\",\n \"customName\": \"DEVA\"\n },\n \"receipt\": \"14b565f2-0bbd-41e7-acba-67b948e4b076\",\n \"created\": \"2020-02-15T00:45:04.7639213Z\"\n}", "language": "json", "name": "API Response" } ] } [/block]
{"_id":"5e332aff5fe1cd396538356d","editedParams":true,"editedParams2":true,"githubsync":"","updates":[],"user":"5509cfc1e463aa3d000dd34a","version":"5e332aff5fe1cd3965383588","category":"5e332aff5fe1cd3965383568","createdAt":"2015-03-25T17:34:37.299Z","project":"55087b0f6065ed17002643ce","__v":22,"link_external":false,"link_url":"","order":0,"title":"Stamp","type":"post","api":{"url":"/stamp","auth":"required","examples":{"codes":[{"code":"curl \\\n  --request POST https://api.snowshoestamp.com/v3/stamp \\\n  --header \"SnowShoe-Api-Key: REPLACE_THIS_WITH_YOUR_API_KEY\" \\\n  --header \"Content-Type: application/json\" \\\n  --data '{\"data\":[[264,172],[267,371],[242,286],[69,375],[66,221]]}'","language":"shell"},{"code":"$.ajax({\n  'url': \"https://api.snowshoestamp.com/v3/stamp\",\n  'method': \"POST\",\n  'headers': {\n    \"SnowShoe-Api-Key\": \"REPLACE_THIS_WITH_YOUR_API_KEY\",\n    \"Content-Type\": \"application/json\"\n  },\n  'data': JSON.stringify({\"data\": [[264,172],[267,371],[242,286],[69,375],[66,221]]}),\n  success: function (response) {\n    console.log(response.stamp.serial);\n  },\n  error: function (response) {\n    console.log(response.responseJSON.error.message);\n  }\n});","language":"javascript"}]},"method":"post","params":[{"name":"SnowShoe-Api-Key","type":"string","default":"","desc":"API Key found in your application settings","required":false,"in":"header","ref":"","_id":"5e47456af7206900384f8397"}],"results":{"codes":[{"language":"json","code":"{\n  \"stamp\": {\n    \"serial\": \"DEVA\",\n    \"customName\": \"DEVA\"\n  },\n  \"receipt\": \"14b565f2-0bbd-41e7-acba-67b948e4b076\",\n  \"created\": \"2020-02-15T00:45:04.7639213Z\"\n}","name":"","status":200},{"status":400,"language":"json","code":"{\n    \"receipt\": \"f9a774d5-f6df-4f76-8dfc-0d69cacec87d\",\n    \"created\": \"2020-02-15T01:14:29.0974658Z\",\n    \"error\": {\n        \"message\": \"Stamp not found\",\n        \"code\": 32\n    }\n}","name":"Stamp not found"},{"name":"Parse error","status":400,"language":"json","code":"{\n    \"receipt\": \"88514ada-76bb-4087-ba89-0f8c5719a299\",\n    \"created\": \"2020-02-15T01:15:15.3992987Z\",\n    \"error\": {\n        \"message\": \"Argument parse error\",\n        \"code\": 30\n    }\n}"},{"name":"Wrong number of points","status":400,"language":"json","code":"{\n    \"receipt\": \"f081f802-6f79-482c-bb15-e17e69025cf4\",\n    \"created\": \"2020-02-15T01:15:45.8152724Z\",\n    \"error\": {\n        \"message\": \"Wrong number of points\",\n        \"code\": 31\n    }\n}"},{"code":"401 Unauthorized response will be returned if the SnowShoe-Api-Key header is missing or invalid.","language":"text","status":401}]},"settings":"5e4744349ec654002ce7fd39"},"hidden":false,"excerpt":"The stamp endpoint receives a JSON object with a single property containing a Base64 encoded array of point data and returns a JSON stamp object containing its serial, custom name, unique receipt, and receipt creation time.","slug":"stamp","sync_unique":"","body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"data\\\": [[264,172],[267,371],[242,286],[69,375],[66,221]]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Request Body\"\n    }\n  ]\n}\n[/block]\n`data` - Array of the measured stamp point values. This particular value equates to a DEVA stamp serial number.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"stamp\\\": {\\n    \\\"serial\\\": \\\"DEVA\\\",\\n    \\\"customName\\\": \\\"DEVA\\\"\\n  },\\n  \\\"receipt\\\": \\\"14b565f2-0bbd-41e7-acba-67b948e4b076\\\",\\n  \\\"created\\\": \\\"2020-02-15T00:45:04.7639213Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"API Response\"\n    }\n  ]\n}\n[/block]\n`serial` - Serial number etched into the side of the physical stamp\n`customName` - Custom name assigned to this stamp (configurable via the [client portal](https://app.snowshoestamp.com/))\n`receipt` - Unique value for the request\n`created` - UTC timestamp of the request","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"isReference":false,"next":{"description":"","pages":[]},"childrenPages":[]}

postStamp

The stamp endpoint receives a JSON object with a single property containing a Base64 encoded array of point data and returns a JSON stamp object containing its serial, custom name, unique receipt, and receipt creation time.

Headers

SnowShoe-Api-Key:
string
API Key found in your application settings
[block:code] { "codes": [ { "code": "{\n \"data\": [[264,172],[267,371],[242,286],[69,375],[66,221]]\n}", "language": "json", "name": "Request Body" } ] } [/block] `data` - Array of the measured stamp point values. This particular value equates to a DEVA stamp serial number. [block:code] { "codes": [ { "code": "{\n \"stamp\": {\n \"serial\": \"DEVA\",\n \"customName\": \"DEVA\"\n },\n \"receipt\": \"14b565f2-0bbd-41e7-acba-67b948e4b076\",\n \"created\": \"2020-02-15T00:45:04.7639213Z\"\n}", "language": "json", "name": "API Response" } ] } [/block] `serial` - Serial number etched into the side of the physical stamp `customName` - Custom name assigned to this stamp (configurable via the [client portal](https://app.snowshoestamp.com/)) `receipt` - Unique value for the request `created` - UTC timestamp of the request

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:code] { "codes": [ { "code": "{\n \"data\": [[264,172],[267,371],[242,286],[69,375],[66,221]]\n}", "language": "json", "name": "Request Body" } ] } [/block] `data` - Array of the measured stamp point values. This particular value equates to a DEVA stamp serial number. [block:code] { "codes": [ { "code": "{\n \"stamp\": {\n \"serial\": \"DEVA\",\n \"customName\": \"DEVA\"\n },\n \"receipt\": \"14b565f2-0bbd-41e7-acba-67b948e4b076\",\n \"created\": \"2020-02-15T00:45:04.7639213Z\"\n}", "language": "json", "name": "API Response" } ] } [/block] `serial` - Serial number etched into the side of the physical stamp `customName` - Custom name assigned to this stamp (configurable via the [client portal](https://app.snowshoestamp.com/)) `receipt` - Unique value for the request `created` - UTC timestamp of the request
{"_id":"5e473cac766eaa001a65f168","project":"55087b0f6065ed17002643ce","version":"5e332aff5fe1cd3965383588","category":"5e332aff5fe1cd396538356a","user":"5509cfc1e463aa3d000dd34a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2020-02-15T00:34:52.244Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Here's an example shell command to submit an API call to the SnowShoe V3 API with CURL.\n\nThe `SnowShoe-Api-Key` header value should be set to your API Key (found in the [client portal](doc:applications) under the Settings of your application).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl \\\\\\n  --request POST https://api.snowshoestamp.com/v3/stamp \\\\\\n  --header \\\"SnowShoe-Api-Key: REPLACE_THIS_WITH_YOUR_API_KEY\\\" \\\\\\n  --header \\\"Content-Type: application/json\\\" \\\\\\n  --data '{\\\"data\\\":[[264,172],[267,371],[242,286],[69,375],[66,221]]}'\",\n      \"language\": \"shell\",\n      \"name\": \"\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"stamp\\\": {\\n    \\\"serial\\\": \\\"DEVA\\\",\\n    \\\"customName\\\": \\\"DEVA\\\"\\n  },\\n  \\\"receipt\\\": \\\"14b565f2-0bbd-41e7-acba-67b948e4b076\\\",\\n  \\\"created\\\": \\\"2020-02-15T00:45:04.7639213Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"API Response\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"testing-with-curl","type":"basic","title":"Testing with CURL","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Testing with CURL


Here's an example shell command to submit an API call to the SnowShoe V3 API with CURL. The `SnowShoe-Api-Key` header value should be set to your API Key (found in the [client portal](doc:applications) under the Settings of your application). [block:code] { "codes": [ { "code": "curl \\\n --request POST https://api.snowshoestamp.com/v3/stamp \\\n --header \"SnowShoe-Api-Key: REPLACE_THIS_WITH_YOUR_API_KEY\" \\\n --header \"Content-Type: application/json\" \\\n --data '{\"data\":[[264,172],[267,371],[242,286],[69,375],[66,221]]}'", "language": "shell", "name": "" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"stamp\": {\n \"serial\": \"DEVA\",\n \"customName\": \"DEVA\"\n },\n \"receipt\": \"14b565f2-0bbd-41e7-acba-67b948e4b076\",\n \"created\": \"2020-02-15T00:45:04.7639213Z\"\n}", "language": "json", "name": "API Response" } ] } [/block]
Here's an example shell command to submit an API call to the SnowShoe V3 API with CURL. The `SnowShoe-Api-Key` header value should be set to your API Key (found in the [client portal](doc:applications) under the Settings of your application). [block:code] { "codes": [ { "code": "curl \\\n --request POST https://api.snowshoestamp.com/v3/stamp \\\n --header \"SnowShoe-Api-Key: REPLACE_THIS_WITH_YOUR_API_KEY\" \\\n --header \"Content-Type: application/json\" \\\n --data '{\"data\":[[264,172],[267,371],[242,286],[69,375],[66,221]]}'", "language": "shell", "name": "" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"stamp\": {\n \"serial\": \"DEVA\",\n \"customName\": \"DEVA\"\n },\n \"receipt\": \"14b565f2-0bbd-41e7-acba-67b948e4b076\",\n \"created\": \"2020-02-15T00:45:04.7639213Z\"\n}", "language": "json", "name": "API Response" } ] } [/block]
{"_id":"5e47560534a9b501a39534ea","project":"55087b0f6065ed17002643ce","version":"5e332aff5fe1cd3965383588","category":"5e332aff5fe1cd396538356a","user":"5509cfc1e463aa3d000dd34a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2020-02-15T02:23:01.403Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"Here are the steps necessary to post a successful API request to the SnowShoe API with [Postman](https://www.postman.com/).\n\n1. Create a new request in Postman\n2. Set the HTTP verb to `POST`\n3. Set the request URL to `https://api.snowshoestamp.com/v3/stamp`\n4. Select the Headers tab\n5. Create a new header with the key `Content-Type` and the value `application/json`\n6. Create a second header with the key `SnowShoe-Api-Key` and set the value to your API Key (found in the [client portal](doc:applications) under the Settings of your application)\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/f69c4d4-Step_1.png\",\n        \"Step 1.png\",\n        902,\n        540,\n        \"#3e444c\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n6. Select the Body tab\n7. Set the body type radio button to `raw` and select `JSON` in the drop down to the right\n8. Use the below JSON value to submit a DEVA stamp serial test\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"data\\\": [[264,172],[267,371],[242,286],[69,375],[66,221]]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/678e909-Step_2.png\",\n        \"Step 2.png\",\n        902,\n        540,\n        \"#393f48\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n9. Click the Send button to post the request\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/714ab58-Stap_3.png\",\n        \"Stap 3.png\",\n        902,\n        540,\n        \"#38404a\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"testing-with-postman","type":"basic","title":"Testing with Postman","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Testing with Postman


Here are the steps necessary to post a successful API request to the SnowShoe API with [Postman](https://www.postman.com/). 1. Create a new request in Postman 2. Set the HTTP verb to `POST` 3. Set the request URL to `https://api.snowshoestamp.com/v3/stamp` 4. Select the Headers tab 5. Create a new header with the key `Content-Type` and the value `application/json` 6. Create a second header with the key `SnowShoe-Api-Key` and set the value to your API Key (found in the [client portal](doc:applications) under the Settings of your application) [block:image] { "images": [ { "image": [ "https://files.readme.io/f69c4d4-Step_1.png", "Step 1.png", 902, 540, "#3e444c" ], "border": true } ] } [/block] 6. Select the Body tab 7. Set the body type radio button to `raw` and select `JSON` in the drop down to the right 8. Use the below JSON value to submit a DEVA stamp serial test [block:code] { "codes": [ { "code": "{\n \"data\": [[264,172],[267,371],[242,286],[69,375],[66,221]]\n}", "language": "json" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/678e909-Step_2.png", "Step 2.png", 902, 540, "#393f48" ], "border": true } ] } [/block] 9. Click the Send button to post the request [block:image] { "images": [ { "image": [ "https://files.readme.io/714ab58-Stap_3.png", "Stap 3.png", 902, 540, "#38404a" ], "border": true } ] } [/block]
Here are the steps necessary to post a successful API request to the SnowShoe API with [Postman](https://www.postman.com/). 1. Create a new request in Postman 2. Set the HTTP verb to `POST` 3. Set the request URL to `https://api.snowshoestamp.com/v3/stamp` 4. Select the Headers tab 5. Create a new header with the key `Content-Type` and the value `application/json` 6. Create a second header with the key `SnowShoe-Api-Key` and set the value to your API Key (found in the [client portal](doc:applications) under the Settings of your application) [block:image] { "images": [ { "image": [ "https://files.readme.io/f69c4d4-Step_1.png", "Step 1.png", 902, 540, "#3e444c" ], "border": true } ] } [/block] 6. Select the Body tab 7. Set the body type radio button to `raw` and select `JSON` in the drop down to the right 8. Use the below JSON value to submit a DEVA stamp serial test [block:code] { "codes": [ { "code": "{\n \"data\": [[264,172],[267,371],[242,286],[69,375],[66,221]]\n}", "language": "json" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/678e909-Step_2.png", "Step 2.png", 902, 540, "#393f48" ], "border": true } ] } [/block] 9. Click the Send button to post the request [block:image] { "images": [ { "image": [ "https://files.readme.io/714ab58-Stap_3.png", "Stap 3.png", 902, 540, "#38404a" ], "border": true } ] } [/block]
{"_id":"5e7e800a2cc561004edc1afe","metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"next":{"description":"","pages":[]},"title":"Migrate to V3","type":"basic","slug":"migrate-to-v3","excerpt":"","body":"Migrating your existing application configuration from V2 to the new V3 platform can be done in 3 steps.\n[block:api-header]\n{\n  \"title\": \"Step 1: Create a V3 account and application\"\n}\n[/block]\nYou will first need to create a new V3 account and application where we will copy your V2 stamps and their configuration. The following settings will be mirrored in your new V3 application:\n* Stamp custom name\n* Stamp active/deactive setting\n\nFollow the steps [here](doc:part-1-create-a-snowshoe-application) to create a new account and application in V3.\n[block:api-header]\n{\n  \"title\": \"Step 2: Contact SnowShoe\"\n}\n[/block]\nContact us via our support email (found [here](doc:contact-email)) with the subject `V3 Migration Request` and include the following information:\n* Your V2 username (email address)\n* The name of the V2 app you want copied\n* Your V3 username (email address)\n* The name of the V3 app\n\nWe will configure your V3 app with the same stamps and stamp configuration found in your V2 app and get back to you within 2 business days.\n[block:api-header]\n{\n  \"title\": \"Step 3: Start updating your stamp app\"\n}\n[/block]\nOur API has changed in V3. Take a look at our [API documentation](doc:stamp) and our new [Libraries](doc:maintained-libraries).\n\nAnd, as always, if you have any questions, please [contact us](doc:contact-email) anytime.","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-03-27T22:36:58.950Z","user":"5509cfc1e463aa3d000dd34a","category":"5e332aff5fe1cd396538356a","version":"5e332aff5fe1cd3965383588","project":"55087b0f6065ed17002643ce","__v":0,"parentDoc":null,"childrenPages":[]}

Migrate to V3


Migrating your existing application configuration from V2 to the new V3 platform can be done in 3 steps. [block:api-header] { "title": "Step 1: Create a V3 account and application" } [/block] You will first need to create a new V3 account and application where we will copy your V2 stamps and their configuration. The following settings will be mirrored in your new V3 application: * Stamp custom name * Stamp active/deactive setting Follow the steps [here](doc:part-1-create-a-snowshoe-application) to create a new account and application in V3. [block:api-header] { "title": "Step 2: Contact SnowShoe" } [/block] Contact us via our support email (found [here](doc:contact-email)) with the subject `V3 Migration Request` and include the following information: * Your V2 username (email address) * The name of the V2 app you want copied * Your V3 username (email address) * The name of the V3 app We will configure your V3 app with the same stamps and stamp configuration found in your V2 app and get back to you within 2 business days. [block:api-header] { "title": "Step 3: Start updating your stamp app" } [/block] Our API has changed in V3. Take a look at our [API documentation](doc:stamp) and our new [Libraries](doc:maintained-libraries). And, as always, if you have any questions, please [contact us](doc:contact-email) anytime.
Migrating your existing application configuration from V2 to the new V3 platform can be done in 3 steps. [block:api-header] { "title": "Step 1: Create a V3 account and application" } [/block] You will first need to create a new V3 account and application where we will copy your V2 stamps and their configuration. The following settings will be mirrored in your new V3 application: * Stamp custom name * Stamp active/deactive setting Follow the steps [here](doc:part-1-create-a-snowshoe-application) to create a new account and application in V3. [block:api-header] { "title": "Step 2: Contact SnowShoe" } [/block] Contact us via our support email (found [here](doc:contact-email)) with the subject `V3 Migration Request` and include the following information: * Your V2 username (email address) * The name of the V2 app you want copied * Your V3 username (email address) * The name of the V3 app We will configure your V3 app with the same stamps and stamp configuration found in your V2 app and get back to you within 2 business days. [block:api-header] { "title": "Step 3: Start updating your stamp app" } [/block] Our API has changed in V3. Take a look at our [API documentation](doc:stamp) and our new [Libraries](doc:maintained-libraries). And, as always, if you have any questions, please [contact us](doc:contact-email) anytime.
{"_id":"5e4c1b3b89488800110be25e","project":"55087b0f6065ed17002643ce","version":"5e332aff5fe1cd3965383588","category":"5e4c1b2afdd77900247e599a","user":"5509cfc1e463aa3d000dd34a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2020-02-18T17:13:31.183Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:api-header]\n{\n  \"title\": \"Analytics\"\n}\n[/block]\nThe Analytics tab is where you can view and compare all activity for all of your apps. You can update the data presented using the date selector in the right hand corner of the page.\n\n## API Calls Chart\n\nThis chart displays all of the API calls for each of your apps over the selected time period.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/561768a-Screen_Shot_2020-02-17_at_10.32.00_AM.png\",\n        \"Screen Shot 2020-02-17 at 10.32.00 AM.png\",\n        2308,\n        1162,\n        \"#e1e3e4\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n## Applications Table\n\nThe table lists all of your applications and their total number of API calls and active stamps for each application over the selected time period.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/4935c69-Screen_Shot_2020-02-17_at_10.32.07_AM.png\",\n        \"Screen Shot 2020-02-17 at 10.32.07 AM.png\",\n        2304,\n        476,\n        \"#d4dada\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Applications\"\n}\n[/block]\nThe Applications tab gives you a table of all of your applications. It includes the application name, description, the number of stamps assigned to that app, and the date it was created. Clicking on an app will bring you to the Application page for that app.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/4fa6d86-Screen_Shot_2020-02-17_at_10.33.38_AM.png\",\n        \"Screen Shot 2020-02-17 at 10.33.38 AM.png\",\n        1964,\n        774,\n        \"#d0d5d6\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Account Settings\"\n}\n[/block]\nThe Account Settings tab is where you can view and update your user information. This page also allows you to update your password.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9c59736-Screen_Shot_2020-02-17_at_10.35.22_AM.png\",\n        \"Screen Shot 2020-02-17 at 10.35.22 AM.png\",\n        994,\n        846,\n        \"#d1d7dc\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Create New App\"\n}\n[/block]\nTo create a new application, click the “New App” button. When presented with the New App modal, fill in the form data and click “Create App.” You will now see a new application listed in the SnowShoe Client Portal.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/bbe2864-Screen_Shot_2020-01-29_at_12.14.05_PM.png\",\n        \"Screen Shot 2020-01-29 at 12.14.05 PM.png\",\n        1012,\n        806,\n        \"#f2f2f2\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]","excerpt":"The Home Page in the Client Portal is where developers can get a snapshot of all of their applications and configure their account settings.","slug":"client-portal-home-page","type":"basic","title":"Home Page","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Home Page

The Home Page in the Client Portal is where developers can get a snapshot of all of their applications and configure their account settings.

[block:api-header] { "title": "Analytics" } [/block] The Analytics tab is where you can view and compare all activity for all of your apps. You can update the data presented using the date selector in the right hand corner of the page. ## API Calls Chart This chart displays all of the API calls for each of your apps over the selected time period. [block:image] { "images": [ { "image": [ "https://files.readme.io/561768a-Screen_Shot_2020-02-17_at_10.32.00_AM.png", "Screen Shot 2020-02-17 at 10.32.00 AM.png", 2308, 1162, "#e1e3e4" ], "border": true } ] } [/block] ## Applications Table The table lists all of your applications and their total number of API calls and active stamps for each application over the selected time period. [block:image] { "images": [ { "image": [ "https://files.readme.io/4935c69-Screen_Shot_2020-02-17_at_10.32.07_AM.png", "Screen Shot 2020-02-17 at 10.32.07 AM.png", 2304, 476, "#d4dada" ], "border": true } ] } [/block] [block:api-header] { "title": "Applications" } [/block] The Applications tab gives you a table of all of your applications. It includes the application name, description, the number of stamps assigned to that app, and the date it was created. Clicking on an app will bring you to the Application page for that app. [block:image] { "images": [ { "image": [ "https://files.readme.io/4fa6d86-Screen_Shot_2020-02-17_at_10.33.38_AM.png", "Screen Shot 2020-02-17 at 10.33.38 AM.png", 1964, 774, "#d0d5d6" ], "border": true } ] } [/block] [block:api-header] { "title": "Account Settings" } [/block] The Account Settings tab is where you can view and update your user information. This page also allows you to update your password. [block:image] { "images": [ { "image": [ "https://files.readme.io/9c59736-Screen_Shot_2020-02-17_at_10.35.22_AM.png", "Screen Shot 2020-02-17 at 10.35.22 AM.png", 994, 846, "#d1d7dc" ], "border": true } ] } [/block] [block:api-header] { "title": "Create New App" } [/block] To create a new application, click the “New App” button. When presented with the New App modal, fill in the form data and click “Create App.” You will now see a new application listed in the SnowShoe Client Portal. [block:image] { "images": [ { "image": [ "https://files.readme.io/bbe2864-Screen_Shot_2020-01-29_at_12.14.05_PM.png", "Screen Shot 2020-01-29 at 12.14.05 PM.png", 1012, 806, "#f2f2f2" ], "border": true } ] } [/block]
[block:api-header] { "title": "Analytics" } [/block] The Analytics tab is where you can view and compare all activity for all of your apps. You can update the data presented using the date selector in the right hand corner of the page. ## API Calls Chart This chart displays all of the API calls for each of your apps over the selected time period. [block:image] { "images": [ { "image": [ "https://files.readme.io/561768a-Screen_Shot_2020-02-17_at_10.32.00_AM.png", "Screen Shot 2020-02-17 at 10.32.00 AM.png", 2308, 1162, "#e1e3e4" ], "border": true } ] } [/block] ## Applications Table The table lists all of your applications and their total number of API calls and active stamps for each application over the selected time period. [block:image] { "images": [ { "image": [ "https://files.readme.io/4935c69-Screen_Shot_2020-02-17_at_10.32.07_AM.png", "Screen Shot 2020-02-17 at 10.32.07 AM.png", 2304, 476, "#d4dada" ], "border": true } ] } [/block] [block:api-header] { "title": "Applications" } [/block] The Applications tab gives you a table of all of your applications. It includes the application name, description, the number of stamps assigned to that app, and the date it was created. Clicking on an app will bring you to the Application page for that app. [block:image] { "images": [ { "image": [ "https://files.readme.io/4fa6d86-Screen_Shot_2020-02-17_at_10.33.38_AM.png", "Screen Shot 2020-02-17 at 10.33.38 AM.png", 1964, 774, "#d0d5d6" ], "border": true } ] } [/block] [block:api-header] { "title": "Account Settings" } [/block] The Account Settings tab is where you can view and update your user information. This page also allows you to update your password. [block:image] { "images": [ { "image": [ "https://files.readme.io/9c59736-Screen_Shot_2020-02-17_at_10.35.22_AM.png", "Screen Shot 2020-02-17 at 10.35.22 AM.png", 994, 846, "#d1d7dc" ], "border": true } ] } [/block] [block:api-header] { "title": "Create New App" } [/block] To create a new application, click the “New App” button. When presented with the New App modal, fill in the form data and click “Create App.” You will now see a new application listed in the SnowShoe Client Portal. [block:image] { "images": [ { "image": [ "https://files.readme.io/bbe2864-Screen_Shot_2020-01-29_at_12.14.05_PM.png", "Screen Shot 2020-01-29 at 12.14.05 PM.png", 1012, 806, "#f2f2f2" ], "border": true } ] } [/block]
{"_id":"5e4c1d3845886e002513b617","project":"55087b0f6065ed17002643ce","version":"5e332aff5fe1cd3965383588","category":"5e4c1b2afdd77900247e599a","user":"5509cfc1e463aa3d000dd34a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2020-02-18T17:22:00.650Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:api-header]\n{\n  \"title\": \"Analytics\"\n}\n[/block]\nThe Application Analytics tab is where you can view and compare all activity for a specific app. You can update the data presented using the date selector in the right hand corner of the page.\n\n## API Calls Chart\n\nThis chart displays all of the API calls for a specific app over the selected time period. It includes data on successful API calls and unsuccessful API calls.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b809d2a-Screen_Shot_2020-02-17_at_10.38.10_AM.png\",\n        \"Screen Shot 2020-02-17 at 10.38.10 AM.png\",\n        2308,\n        1148,\n        \"#dcdedd\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n## Active Stamps\n\nThis chart displays the percentage of the stamps assigned to a specific app that are active over the selected time period.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/8012897-Screen_Shot_2020-02-17_at_10.38.52_AM.png\",\n        \"Screen Shot 2020-02-17 at 10.38.52 AM.png\",\n        774,\n        522,\n        \"#047cfb\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n## Most Active Stamps\n\nThis table displays the top five most active stamps for the selected time period.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/02d2013-Screen_Shot_2020-02-17_at_10.39.25_AM.png\",\n        \"Screen Shot 2020-02-17 at 10.39.25 AM.png\",\n        906,\n        812,\n        \"#282930\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Stamps\"\n}\n[/block]\nThe Stamps tab gives you a table of all of the stamps assigned to that application. It includes the stamp serial number, custom name, if the stamp is enabled or disabled, and its last API call. Clicking on a stamp will bring you to the Stamp page for that stamp.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/8dafd54-Screen_Shot_2020-02-17_at_10.40.21_AM.png\",\n        \"Screen Shot 2020-02-17 at 10.40.21 AM.png\",\n        1924,\n        1212,\n        \"#256541\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Settings\"\n}\n[/block]\nThe Application Settings tab is where you can view and update the applications info. This page also allows you to delete the application.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/169d103-Screen_Shot_2020-02-17_at_10.40.48_AM.png\",\n        \"Screen Shot 2020-02-17 at 10.40.48 AM.png\",\n        1782,\n        1154,\n        \"#d2d6d8\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]","excerpt":"The Application page is where you can view all of the analytics and settings for a particular app.","slug":"client-portal-application","type":"basic","title":"Application","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Application

The Application page is where you can view all of the analytics and settings for a particular app.

[block:api-header] { "title": "Analytics" } [/block] The Application Analytics tab is where you can view and compare all activity for a specific app. You can update the data presented using the date selector in the right hand corner of the page. ## API Calls Chart This chart displays all of the API calls for a specific app over the selected time period. It includes data on successful API calls and unsuccessful API calls. [block:image] { "images": [ { "image": [ "https://files.readme.io/b809d2a-Screen_Shot_2020-02-17_at_10.38.10_AM.png", "Screen Shot 2020-02-17 at 10.38.10 AM.png", 2308, 1148, "#dcdedd" ], "border": true } ] } [/block] ## Active Stamps This chart displays the percentage of the stamps assigned to a specific app that are active over the selected time period. [block:image] { "images": [ { "image": [ "https://files.readme.io/8012897-Screen_Shot_2020-02-17_at_10.38.52_AM.png", "Screen Shot 2020-02-17 at 10.38.52 AM.png", 774, 522, "#047cfb" ], "border": true } ] } [/block] ## Most Active Stamps This table displays the top five most active stamps for the selected time period. [block:image] { "images": [ { "image": [ "https://files.readme.io/02d2013-Screen_Shot_2020-02-17_at_10.39.25_AM.png", "Screen Shot 2020-02-17 at 10.39.25 AM.png", 906, 812, "#282930" ], "border": true } ] } [/block] [block:api-header] { "title": "Stamps" } [/block] The Stamps tab gives you a table of all of the stamps assigned to that application. It includes the stamp serial number, custom name, if the stamp is enabled or disabled, and its last API call. Clicking on a stamp will bring you to the Stamp page for that stamp. [block:image] { "images": [ { "image": [ "https://files.readme.io/8dafd54-Screen_Shot_2020-02-17_at_10.40.21_AM.png", "Screen Shot 2020-02-17 at 10.40.21 AM.png", 1924, 1212, "#256541" ], "border": true } ] } [/block] [block:api-header] { "title": "Settings" } [/block] The Application Settings tab is where you can view and update the applications info. This page also allows you to delete the application. [block:image] { "images": [ { "image": [ "https://files.readme.io/169d103-Screen_Shot_2020-02-17_at_10.40.48_AM.png", "Screen Shot 2020-02-17 at 10.40.48 AM.png", 1782, 1154, "#d2d6d8" ], "border": true } ] } [/block]
[block:api-header] { "title": "Analytics" } [/block] The Application Analytics tab is where you can view and compare all activity for a specific app. You can update the data presented using the date selector in the right hand corner of the page. ## API Calls Chart This chart displays all of the API calls for a specific app over the selected time period. It includes data on successful API calls and unsuccessful API calls. [block:image] { "images": [ { "image": [ "https://files.readme.io/b809d2a-Screen_Shot_2020-02-17_at_10.38.10_AM.png", "Screen Shot 2020-02-17 at 10.38.10 AM.png", 2308, 1148, "#dcdedd" ], "border": true } ] } [/block] ## Active Stamps This chart displays the percentage of the stamps assigned to a specific app that are active over the selected time period. [block:image] { "images": [ { "image": [ "https://files.readme.io/8012897-Screen_Shot_2020-02-17_at_10.38.52_AM.png", "Screen Shot 2020-02-17 at 10.38.52 AM.png", 774, 522, "#047cfb" ], "border": true } ] } [/block] ## Most Active Stamps This table displays the top five most active stamps for the selected time period. [block:image] { "images": [ { "image": [ "https://files.readme.io/02d2013-Screen_Shot_2020-02-17_at_10.39.25_AM.png", "Screen Shot 2020-02-17 at 10.39.25 AM.png", 906, 812, "#282930" ], "border": true } ] } [/block] [block:api-header] { "title": "Stamps" } [/block] The Stamps tab gives you a table of all of the stamps assigned to that application. It includes the stamp serial number, custom name, if the stamp is enabled or disabled, and its last API call. Clicking on a stamp will bring you to the Stamp page for that stamp. [block:image] { "images": [ { "image": [ "https://files.readme.io/8dafd54-Screen_Shot_2020-02-17_at_10.40.21_AM.png", "Screen Shot 2020-02-17 at 10.40.21 AM.png", 1924, 1212, "#256541" ], "border": true } ] } [/block] [block:api-header] { "title": "Settings" } [/block] The Application Settings tab is where you can view and update the applications info. This page also allows you to delete the application. [block:image] { "images": [ { "image": [ "https://files.readme.io/169d103-Screen_Shot_2020-02-17_at_10.40.48_AM.png", "Screen Shot 2020-02-17 at 10.40.48 AM.png", 1782, 1154, "#d2d6d8" ], "border": true } ] } [/block]
{"_id":"5e4c227fe97e03005e80eac7","project":"55087b0f6065ed17002643ce","version":"5e332aff5fe1cd3965383588","category":"5e4c1b2afdd77900247e599a","user":"5509cfc1e463aa3d000dd34a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2020-02-18T17:44:31.378Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"The API Keys are what you will use in your client application whenever you make a request to the SnowShoe platform. They are how the SnowShoe platform identifies your application in each request. They are coded into your app. You will only need to use one of the two API keys in your client application however both are valid.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"We provide you with 2 API Keys to allow for easy key regeneration without any downtime.\\n\\nIf you need to regenerate API Key 1:\\n1. Ensure your application is configured to use API Key 2\\n2. Click the \\\"Regenerate\\\" button under API Key 1 and confirm\\n\\nTo regenerate API Key 2, repeat the steps above by swapping the keys.\",\n  \"title\": \"Regenerating your API Keys\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"The old API Keys will no longer work after a new key has been generated and **cannot be recovered**. All requests to the SnowShoe platform using the old API key will be rejected.\\n\\nPlease take care when going through this process to ensure all applications using the key you want to regenerate have been updated to use the other key.\",\n  \"title\": \"Be careful regenerating API Keys\"\n}\n[/block]","excerpt":"","slug":"client-portal-api-keys","type":"basic","title":"API Keys","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

API Keys


The API Keys are what you will use in your client application whenever you make a request to the SnowShoe platform. They are how the SnowShoe platform identifies your application in each request. They are coded into your app. You will only need to use one of the two API keys in your client application however both are valid. [block:callout] { "type": "info", "body": "We provide you with 2 API Keys to allow for easy key regeneration without any downtime.\n\nIf you need to regenerate API Key 1:\n1. Ensure your application is configured to use API Key 2\n2. Click the \"Regenerate\" button under API Key 1 and confirm\n\nTo regenerate API Key 2, repeat the steps above by swapping the keys.", "title": "Regenerating your API Keys" } [/block] [block:callout] { "type": "danger", "body": "The old API Keys will no longer work after a new key has been generated and **cannot be recovered**. All requests to the SnowShoe platform using the old API key will be rejected.\n\nPlease take care when going through this process to ensure all applications using the key you want to regenerate have been updated to use the other key.", "title": "Be careful regenerating API Keys" } [/block]
The API Keys are what you will use in your client application whenever you make a request to the SnowShoe platform. They are how the SnowShoe platform identifies your application in each request. They are coded into your app. You will only need to use one of the two API keys in your client application however both are valid. [block:callout] { "type": "info", "body": "We provide you with 2 API Keys to allow for easy key regeneration without any downtime.\n\nIf you need to regenerate API Key 1:\n1. Ensure your application is configured to use API Key 2\n2. Click the \"Regenerate\" button under API Key 1 and confirm\n\nTo regenerate API Key 2, repeat the steps above by swapping the keys.", "title": "Regenerating your API Keys" } [/block] [block:callout] { "type": "danger", "body": "The old API Keys will no longer work after a new key has been generated and **cannot be recovered**. All requests to the SnowShoe platform using the old API key will be rejected.\n\nPlease take care when going through this process to ensure all applications using the key you want to regenerate have been updated to use the other key.", "title": "Be careful regenerating API Keys" } [/block]
{"_id":"5e4c1ed87e58cd00391383eb","project":"55087b0f6065ed17002643ce","version":"5e332aff5fe1cd3965383588","category":"5e4c1b2afdd77900247e599a","user":"5509cfc1e463aa3d000dd34a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2020-02-18T17:28:56.874Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"[block:api-header]\n{\n  \"title\": \"Analytics\"\n}\n[/block]\nThe Stamp Analytics tab is where you can view all activity for a particular stamp. You can update the data presented using the date selector in the right hand corner of the page.\n\n## API Calls Chart\n\nThis chart displays all of the API calls a particular stamp over the selected time period.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/735cf32-Screen_Shot_2020-02-17_at_10.43.14_AM.png\",\n        \"Screen Shot 2020-02-17 at 10.43.14 AM.png\",\n        2324,\n        1126,\n        \"#dee2dc\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Settings\"\n}\n[/block]\nThe Stamp Settings tab is where you can view and update a particular stamp’s info. This page also allows you to enable/disable a stamp.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2863cbd-Screen_Shot_2020-02-17_at_10.44.40_AM.png\",\n        \"Screen Shot 2020-02-17 at 10.44.40 AM.png\",\n        994,\n        890,\n        \"#d6b4bb\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Disable/Enable Stamp\"\n}\n[/block]\nOn the Stamp Settings tab, a stamp can be disabled and enabled. When a stamp is disabled, all requests made to the SnowShoe Platform with that stamp serial number will be rejected. Once a stamp is re-enabled, all requests to the SnowShoe Platform will be accepted again.","excerpt":"The Stamp page is where you can view all of the analytics and settings for a particular stamp.","slug":"client-portal-stamp","type":"basic","title":"Stamp","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Stamp

The Stamp page is where you can view all of the analytics and settings for a particular stamp.

[block:api-header] { "title": "Analytics" } [/block] The Stamp Analytics tab is where you can view all activity for a particular stamp. You can update the data presented using the date selector in the right hand corner of the page. ## API Calls Chart This chart displays all of the API calls a particular stamp over the selected time period. [block:image] { "images": [ { "image": [ "https://files.readme.io/735cf32-Screen_Shot_2020-02-17_at_10.43.14_AM.png", "Screen Shot 2020-02-17 at 10.43.14 AM.png", 2324, 1126, "#dee2dc" ], "border": true } ] } [/block] [block:api-header] { "title": "Settings" } [/block] The Stamp Settings tab is where you can view and update a particular stamp’s info. This page also allows you to enable/disable a stamp. [block:image] { "images": [ { "image": [ "https://files.readme.io/2863cbd-Screen_Shot_2020-02-17_at_10.44.40_AM.png", "Screen Shot 2020-02-17 at 10.44.40 AM.png", 994, 890, "#d6b4bb" ], "border": true } ] } [/block] [block:api-header] { "title": "Disable/Enable Stamp" } [/block] On the Stamp Settings tab, a stamp can be disabled and enabled. When a stamp is disabled, all requests made to the SnowShoe Platform with that stamp serial number will be rejected. Once a stamp is re-enabled, all requests to the SnowShoe Platform will be accepted again.
[block:api-header] { "title": "Analytics" } [/block] The Stamp Analytics tab is where you can view all activity for a particular stamp. You can update the data presented using the date selector in the right hand corner of the page. ## API Calls Chart This chart displays all of the API calls a particular stamp over the selected time period. [block:image] { "images": [ { "image": [ "https://files.readme.io/735cf32-Screen_Shot_2020-02-17_at_10.43.14_AM.png", "Screen Shot 2020-02-17 at 10.43.14 AM.png", 2324, 1126, "#dee2dc" ], "border": true } ] } [/block] [block:api-header] { "title": "Settings" } [/block] The Stamp Settings tab is where you can view and update a particular stamp’s info. This page also allows you to enable/disable a stamp. [block:image] { "images": [ { "image": [ "https://files.readme.io/2863cbd-Screen_Shot_2020-02-17_at_10.44.40_AM.png", "Screen Shot 2020-02-17 at 10.44.40 AM.png", 994, 890, "#d6b4bb" ], "border": true } ] } [/block] [block:api-header] { "title": "Disable/Enable Stamp" } [/block] On the Stamp Settings tab, a stamp can be disabled and enabled. When a stamp is disabled, all requests made to the SnowShoe Platform with that stamp serial number will be rejected. Once a stamp is re-enabled, all requests to the SnowShoe Platform will be accepted again.
{"_id":"5e332aff5fe1cd3965383578","title":"Device Compatibility","type":"basic","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"link_url":"","body":"SnowShoe aspires to engineer physical hardware that can be detected by, and interact with, every touchscreen-powered device in the world. \n\nFulfilling this dream is hard, but we work towards it every day. Every device on the market today uses different combinations of hardware and firmware to power their capacitive touch screens. To be successful in our ambition, SnowShoe must:\n\n1. Determine a hardware specification that should function correctly on the highly disparate hardware and software that powers all of the various devices on the market.\n\n2. Consistently manufacture hardware, at scale, to meet that specification.\n\n3. Develop a QA process that allows us to be confident that the hardware we are shipping meet that specification.\n\nStamps get tested multiple times throughout the manufacturing, validation, and stamp assignment process. Touchscreen sensitivity and detection capabilities continue to improve and we test a wide variety a new devices on the market as they become available.\n\nMake sure to check the [troubleshooting](doc:troubleshooting) section below if you are having issues with a specific device.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"Cracked screens and thick screen protectors have been known to cause issues with stamp readability.\\n\\n[More Information](doc:cracked-screens)\",\n  \"title\": \"Cracked screens and screen protectors\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Individually unique stamps are not guaranteed to work on a subset of legacy HTC devices because of default settings in their firmware. This can often be fixed by toggling the default multitouch setting that allow the phones to sense more than 3 simultaneous touch events.\",\n  \"title\": \"Legacy HTC devices\"\n}\n[/block]\nAre you having issues with a specific device? Please [contact us](doc:contact-email).","category":"5e332aff5fe1cd3965383569","githubsync":"","hidden":false,"link_external":false,"version":"5e332aff5fe1cd3965383588","__v":26,"sync_unique":"","user":"5509cfc1e463aa3d000dd34a","project":"55087b0f6065ed17002643ce","slug":"device-compatibility","isReference":false,"order":0,"updates":["5705771c3e55070e00914fc3"],"createdAt":"2015-04-01T23:45:05.518Z","excerpt":"","next":{"description":"","pages":[]},"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Device Compatibility


SnowShoe aspires to engineer physical hardware that can be detected by, and interact with, every touchscreen-powered device in the world. Fulfilling this dream is hard, but we work towards it every day. Every device on the market today uses different combinations of hardware and firmware to power their capacitive touch screens. To be successful in our ambition, SnowShoe must: 1. Determine a hardware specification that should function correctly on the highly disparate hardware and software that powers all of the various devices on the market. 2. Consistently manufacture hardware, at scale, to meet that specification. 3. Develop a QA process that allows us to be confident that the hardware we are shipping meet that specification. Stamps get tested multiple times throughout the manufacturing, validation, and stamp assignment process. Touchscreen sensitivity and detection capabilities continue to improve and we test a wide variety a new devices on the market as they become available. Make sure to check the [troubleshooting](doc:troubleshooting) section below if you are having issues with a specific device. [block:callout] { "type": "danger", "body": "Cracked screens and thick screen protectors have been known to cause issues with stamp readability.\n\n[More Information](doc:cracked-screens)", "title": "Cracked screens and screen protectors" } [/block] [block:callout] { "type": "warning", "body": "Individually unique stamps are not guaranteed to work on a subset of legacy HTC devices because of default settings in their firmware. This can often be fixed by toggling the default multitouch setting that allow the phones to sense more than 3 simultaneous touch events.", "title": "Legacy HTC devices" } [/block] Are you having issues with a specific device? Please [contact us](doc:contact-email).
SnowShoe aspires to engineer physical hardware that can be detected by, and interact with, every touchscreen-powered device in the world. Fulfilling this dream is hard, but we work towards it every day. Every device on the market today uses different combinations of hardware and firmware to power their capacitive touch screens. To be successful in our ambition, SnowShoe must: 1. Determine a hardware specification that should function correctly on the highly disparate hardware and software that powers all of the various devices on the market. 2. Consistently manufacture hardware, at scale, to meet that specification. 3. Develop a QA process that allows us to be confident that the hardware we are shipping meet that specification. Stamps get tested multiple times throughout the manufacturing, validation, and stamp assignment process. Touchscreen sensitivity and detection capabilities continue to improve and we test a wide variety a new devices on the market as they become available. Make sure to check the [troubleshooting](doc:troubleshooting) section below if you are having issues with a specific device. [block:callout] { "type": "danger", "body": "Cracked screens and thick screen protectors have been known to cause issues with stamp readability.\n\n[More Information](doc:cracked-screens)", "title": "Cracked screens and screen protectors" } [/block] [block:callout] { "type": "warning", "body": "Individually unique stamps are not guaranteed to work on a subset of legacy HTC devices because of default settings in their firmware. This can often be fixed by toggling the default multitouch setting that allow the phones to sense more than 3 simultaneous touch events.", "title": "Legacy HTC devices" } [/block] Are you having issues with a specific device? Please [contact us](doc:contact-email).
{"_id":"5e332aff5fe1cd396538357a","excerpt":"","githubsync":"","isReference":false,"link_url":"","order":1,"slug":"troubleshooting","version":"5e332aff5fe1cd3965383588","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"Cracked screens and thick screen protectors have been known to cause issues with stamp readability.\\n\\n[More Information](doc:cracked-screens)\",\n  \"title\": \"Cracked screens and screen protectors\"\n}\n[/block]\nBelow is a known list of issues with the platform, planned pathways to resolution, and current status.\n\n**I received the Error Page, what does that mean?**\n\nIt means that your phone didn’t detect all five points of the stamp. Try stamping again to ensure flat, solid contact between the device screen and the stamp.\n\n\n**I received the Invalid Stamp screen. What does that mean?**\n\nIt means that the app was expecting to see a different stamp than the one it observed. You can see this page again if you touch SnowShoe’s demo stamp screen with your five fingers.\n\nIf you see this page consistently while using SnowShoe’s demo with your stamps, please [contact us](doc:contact-email).\n\n\n**The stamp doesn't work when my phone is not being held. For instance, when it's resting on a table.**\n\nStamps use the capacitive properties of your touchscreen, which register touches by sensing a change in the electrostatic field that results when your body, an electric conductor, touches a particular part of the screen. Just as a phone senses your fingers when you tap or gesture, it senses a specific pattern on the bottom of the stamps in the same way. Because your body provides much of the energy for the interaction, *it's important that you hold the phone while stamping*.\n\nWe are working on mounted installations and can provide you with some specific rigging instructions if this is important to your implementation that will maximize stamp recognition success.\n\n\n**One or both of the my stamps work intermittently.**\n\nIf the stamps work, but not consistently, try holding the phone and slightly rotating the stamp once it's touched to the screen to see if you observe better results. Make sure your phone isn’t plugged into a power source.\n\nWe are working on modifying the stamp and the algorithm to improve the stamp success rate. Don't hesitate to reach out if you continue to have issues. We can look into replacing your stamp(s).\n\n\n**Stamps are not working on my HTC One.**\n\nHTC One’s default settings are initially set to only detect 3 finger gestures, however, the device can detect up to 10 simultaneous gestures. To fix this issue go to:\n* Settings > Displays and Gestures\n* Uncheck “HTC Gestures ~ Enable 3 finger gestures and ignore gestures with more fingers.”\n\n\n**I think my stamp is damaged. What should I do?**\n\nYou’ve tried everything above and you still can’t get your stamps to work?\n\nContact us directly if you are only getting an error page with both stamps. We would like to find out what device you are testing and walk through potential issues. [Contact us](doc:contact-email) and we'll send you another stamp as soon as possible.\n\nIf you find other bugs or need additional information please [contact us](doc:contact-email) with details.","hidden":false,"title":"Troubleshooting","category":"5e332aff5fe1cd3965383569","sync_unique":"","user":"5509cfc1e463aa3d000dd34a","__v":14,"createdAt":"2015-05-28T21:12:56.812Z","link_external":false,"project":"55087b0f6065ed17002643ce","type":"basic","updates":[],"next":{"description":"","pages":[]},"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Troubleshooting


[block:callout] { "type": "danger", "body": "Cracked screens and thick screen protectors have been known to cause issues with stamp readability.\n\n[More Information](doc:cracked-screens)", "title": "Cracked screens and screen protectors" } [/block] Below is a known list of issues with the platform, planned pathways to resolution, and current status. **I received the Error Page, what does that mean?** It means that your phone didn’t detect all five points of the stamp. Try stamping again to ensure flat, solid contact between the device screen and the stamp. **I received the Invalid Stamp screen. What does that mean?** It means that the app was expecting to see a different stamp than the one it observed. You can see this page again if you touch SnowShoe’s demo stamp screen with your five fingers. If you see this page consistently while using SnowShoe’s demo with your stamps, please [contact us](doc:contact-email). **The stamp doesn't work when my phone is not being held. For instance, when it's resting on a table.** Stamps use the capacitive properties of your touchscreen, which register touches by sensing a change in the electrostatic field that results when your body, an electric conductor, touches a particular part of the screen. Just as a phone senses your fingers when you tap or gesture, it senses a specific pattern on the bottom of the stamps in the same way. Because your body provides much of the energy for the interaction, *it's important that you hold the phone while stamping*. We are working on mounted installations and can provide you with some specific rigging instructions if this is important to your implementation that will maximize stamp recognition success. **One or both of the my stamps work intermittently.** If the stamps work, but not consistently, try holding the phone and slightly rotating the stamp once it's touched to the screen to see if you observe better results. Make sure your phone isn’t plugged into a power source. We are working on modifying the stamp and the algorithm to improve the stamp success rate. Don't hesitate to reach out if you continue to have issues. We can look into replacing your stamp(s). **Stamps are not working on my HTC One.** HTC One’s default settings are initially set to only detect 3 finger gestures, however, the device can detect up to 10 simultaneous gestures. To fix this issue go to: * Settings > Displays and Gestures * Uncheck “HTC Gestures ~ Enable 3 finger gestures and ignore gestures with more fingers.” **I think my stamp is damaged. What should I do?** You’ve tried everything above and you still can’t get your stamps to work? Contact us directly if you are only getting an error page with both stamps. We would like to find out what device you are testing and walk through potential issues. [Contact us](doc:contact-email) and we'll send you another stamp as soon as possible. If you find other bugs or need additional information please [contact us](doc:contact-email) with details.
[block:callout] { "type": "danger", "body": "Cracked screens and thick screen protectors have been known to cause issues with stamp readability.\n\n[More Information](doc:cracked-screens)", "title": "Cracked screens and screen protectors" } [/block] Below is a known list of issues with the platform, planned pathways to resolution, and current status. **I received the Error Page, what does that mean?** It means that your phone didn’t detect all five points of the stamp. Try stamping again to ensure flat, solid contact between the device screen and the stamp. **I received the Invalid Stamp screen. What does that mean?** It means that the app was expecting to see a different stamp than the one it observed. You can see this page again if you touch SnowShoe’s demo stamp screen with your five fingers. If you see this page consistently while using SnowShoe’s demo with your stamps, please [contact us](doc:contact-email). **The stamp doesn't work when my phone is not being held. For instance, when it's resting on a table.** Stamps use the capacitive properties of your touchscreen, which register touches by sensing a change in the electrostatic field that results when your body, an electric conductor, touches a particular part of the screen. Just as a phone senses your fingers when you tap or gesture, it senses a specific pattern on the bottom of the stamps in the same way. Because your body provides much of the energy for the interaction, *it's important that you hold the phone while stamping*. We are working on mounted installations and can provide you with some specific rigging instructions if this is important to your implementation that will maximize stamp recognition success. **One or both of the my stamps work intermittently.** If the stamps work, but not consistently, try holding the phone and slightly rotating the stamp once it's touched to the screen to see if you observe better results. Make sure your phone isn’t plugged into a power source. We are working on modifying the stamp and the algorithm to improve the stamp success rate. Don't hesitate to reach out if you continue to have issues. We can look into replacing your stamp(s). **Stamps are not working on my HTC One.** HTC One’s default settings are initially set to only detect 3 finger gestures, however, the device can detect up to 10 simultaneous gestures. To fix this issue go to: * Settings > Displays and Gestures * Uncheck “HTC Gestures ~ Enable 3 finger gestures and ignore gestures with more fingers.” **I think my stamp is damaged. What should I do?** You’ve tried everything above and you still can’t get your stamps to work? Contact us directly if you are only getting an error page with both stamps. We would like to find out what device you are testing and walk through potential issues. [Contact us](doc:contact-email) and we'll send you another stamp as soon as possible. If you find other bugs or need additional information please [contact us](doc:contact-email) with details.
{"_id":"5e332aff5fe1cd396538357e","link_external":false,"sync_unique":"","title":"Sticker Templates","api":{"auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[Download sticker template (ai)](https://downloads.snowshoestamp.com/stickers/sticker_template.ai)\n\n**Design your sticker**\nOpen the template above in Adobe Illustrator, make your edits, and save. For optimal prints, be sure to create artwork using CMYK color mode and change all text to outlines before saving.\n\n**Upload your artwork to a sticker printer**\n1. SnowShoe loves [StickerGiant](https://www.stickergiant.com/) - visit their site and click **Get Stickers**.\n2. Choose **'Die Cut' stickers**.\n3. Select **‘Glossy’** for a durable laminated sticker or **‘Matte’** for a less durable but more organic finish.\n4. Choose a **'Custom Shape'**\n5. Enter **W: 1\"** and **H: 1\"** \n6. Select your quantity. *For smaller quantities you can use [Sticker Mule](https://www.stickermule.com/) as an alternative provider.*\n7. Upload your sticker file\n8. When prompted for additional instructions, enter \"Please trim the white portions off the corners. The final sticker should have rounded corners. Thanks!\"\n9. Checkout\n10. Wait for your proof. *The quicker you approve your design, the quicker you will get your stickers*.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Printing Lead Times\",\n  \"body\": \"Keep in mind the lead time you need for your sticker order to arrive so you have time to assemble them. Most vendors support rush orders, but we suggest placing your order **two weeks** before your event to keep shipping costs at a minimum. This should get you your stamps about one week prior to your event.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e68VrjFfSSiIOaiN2hyN_Screen%20Shot%202015-10-26%20at%205.54.29%20PM.png\",\n        \"Screen Shot 2015-10-26 at 5.54.29 PM.png\",\n        \"1088\",\n        \"1072\",\n        \"#3b9bdb\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n**Sticker Application**\nApplying stamp stickers is a simple process. Here are a few tips to get great results.\n\nStart by only opening one box of stamps at a time to avoid mixing up serial numbers between boxes. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/50ec57f-image1.jpg\",\n        \"image1.jpg\",\n        1999,\n        1999,\n        \"#50585f\"\n      ]\n    }\n  ]\n}\n[/block]\nSticker Giant uses a crack and peel backing that makes removing the backing and aligning the sticker easier.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/bafd930-image6.jpg\",\n        \"image6.jpg\",\n        1999,\n        1999,\n        \"#484f53\"\n      ]\n    }\n  ]\n}\n[/block]\nLightly bend the sticker and then remove one half of the backing material.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b7437ab-image2.jpg\",\n        \"image2.jpg\",\n        1999,\n        1999,\n        \"#60676a\"\n      ]\n    }\n  ]\n}\n[/block]\nAlign the sticker in the handle’s sticker well in your preferred orientation and attach the edge of the sticker.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/c726149-image5.jpg\",\n        \"image5.jpg\",\n        1999,\n        1999,\n        \"#5c5d5d\"\n      ]\n    }\n  ]\n}\n[/block]\nOnce the stamp is aligned correctly you can remove the remainder of the backing material and press the sticker into place.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e75e650-image3.jpg\",\n        \"image3.jpg\",\n        1999,\n        1999,\n        \"#4e565c\"\n      ]\n    }\n  ]\n}\n[/block]","category":"5e332aff5fe1cd3965383569","createdAt":"2015-08-19T18:05:25.334Z","hidden":false,"isReference":false,"updates":[],"version":"5e332aff5fe1cd3965383588","githubsync":"","link_url":"","order":2,"project":"55087b0f6065ed17002643ce","__v":9,"excerpt":"We're big fans of adding high quality vinyl stickers to the tops of our stamps. Follow the instructions below to customize your stamps.","slug":"sticker-templates","type":"basic","user":"5509cfc1e463aa3d000dd34a","next":{"description":"","pages":[]},"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Sticker Templates

We're big fans of adding high quality vinyl stickers to the tops of our stamps. Follow the instructions below to customize your stamps.

[Download sticker template (ai)](https://downloads.snowshoestamp.com/stickers/sticker_template.ai) **Design your sticker** Open the template above in Adobe Illustrator, make your edits, and save. For optimal prints, be sure to create artwork using CMYK color mode and change all text to outlines before saving. **Upload your artwork to a sticker printer** 1. SnowShoe loves [StickerGiant](https://www.stickergiant.com/) - visit their site and click **Get Stickers**. 2. Choose **'Die Cut' stickers**. 3. Select **‘Glossy’** for a durable laminated sticker or **‘Matte’** for a less durable but more organic finish. 4. Choose a **'Custom Shape'** 5. Enter **W: 1"** and **H: 1"** 6. Select your quantity. *For smaller quantities you can use [Sticker Mule](https://www.stickermule.com/) as an alternative provider.* 7. Upload your sticker file 8. When prompted for additional instructions, enter "Please trim the white portions off the corners. The final sticker should have rounded corners. Thanks!" 9. Checkout 10. Wait for your proof. *The quicker you approve your design, the quicker you will get your stickers*. [block:callout] { "type": "info", "title": "Printing Lead Times", "body": "Keep in mind the lead time you need for your sticker order to arrive so you have time to assemble them. Most vendors support rush orders, but we suggest placing your order **two weeks** before your event to keep shipping costs at a minimum. This should get you your stamps about one week prior to your event." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/e68VrjFfSSiIOaiN2hyN_Screen%20Shot%202015-10-26%20at%205.54.29%20PM.png", "Screen Shot 2015-10-26 at 5.54.29 PM.png", "1088", "1072", "#3b9bdb", "" ] } ] } [/block] **Sticker Application** Applying stamp stickers is a simple process. Here are a few tips to get great results. Start by only opening one box of stamps at a time to avoid mixing up serial numbers between boxes. [block:image] { "images": [ { "image": [ "https://files.readme.io/50ec57f-image1.jpg", "image1.jpg", 1999, 1999, "#50585f" ] } ] } [/block] Sticker Giant uses a crack and peel backing that makes removing the backing and aligning the sticker easier. [block:image] { "images": [ { "image": [ "https://files.readme.io/bafd930-image6.jpg", "image6.jpg", 1999, 1999, "#484f53" ] } ] } [/block] Lightly bend the sticker and then remove one half of the backing material. [block:image] { "images": [ { "image": [ "https://files.readme.io/b7437ab-image2.jpg", "image2.jpg", 1999, 1999, "#60676a" ] } ] } [/block] Align the sticker in the handle’s sticker well in your preferred orientation and attach the edge of the sticker. [block:image] { "images": [ { "image": [ "https://files.readme.io/c726149-image5.jpg", "image5.jpg", 1999, 1999, "#5c5d5d" ] } ] } [/block] Once the stamp is aligned correctly you can remove the remainder of the backing material and press the sticker into place. [block:image] { "images": [ { "image": [ "https://files.readme.io/e75e650-image3.jpg", "image3.jpg", 1999, 1999, "#4e565c" ] } ] } [/block]
[Download sticker template (ai)](https://downloads.snowshoestamp.com/stickers/sticker_template.ai) **Design your sticker** Open the template above in Adobe Illustrator, make your edits, and save. For optimal prints, be sure to create artwork using CMYK color mode and change all text to outlines before saving. **Upload your artwork to a sticker printer** 1. SnowShoe loves [StickerGiant](https://www.stickergiant.com/) - visit their site and click **Get Stickers**. 2. Choose **'Die Cut' stickers**. 3. Select **‘Glossy’** for a durable laminated sticker or **‘Matte’** for a less durable but more organic finish. 4. Choose a **'Custom Shape'** 5. Enter **W: 1"** and **H: 1"** 6. Select your quantity. *For smaller quantities you can use [Sticker Mule](https://www.stickermule.com/) as an alternative provider.* 7. Upload your sticker file 8. When prompted for additional instructions, enter "Please trim the white portions off the corners. The final sticker should have rounded corners. Thanks!" 9. Checkout 10. Wait for your proof. *The quicker you approve your design, the quicker you will get your stickers*. [block:callout] { "type": "info", "title": "Printing Lead Times", "body": "Keep in mind the lead time you need for your sticker order to arrive so you have time to assemble them. Most vendors support rush orders, but we suggest placing your order **two weeks** before your event to keep shipping costs at a minimum. This should get you your stamps about one week prior to your event." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/e68VrjFfSSiIOaiN2hyN_Screen%20Shot%202015-10-26%20at%205.54.29%20PM.png", "Screen Shot 2015-10-26 at 5.54.29 PM.png", "1088", "1072", "#3b9bdb", "" ] } ] } [/block] **Sticker Application** Applying stamp stickers is a simple process. Here are a few tips to get great results. Start by only opening one box of stamps at a time to avoid mixing up serial numbers between boxes. [block:image] { "images": [ { "image": [ "https://files.readme.io/50ec57f-image1.jpg", "image1.jpg", 1999, 1999, "#50585f" ] } ] } [/block] Sticker Giant uses a crack and peel backing that makes removing the backing and aligning the sticker easier. [block:image] { "images": [ { "image": [ "https://files.readme.io/bafd930-image6.jpg", "image6.jpg", 1999, 1999, "#484f53" ] } ] } [/block] Lightly bend the sticker and then remove one half of the backing material. [block:image] { "images": [ { "image": [ "https://files.readme.io/b7437ab-image2.jpg", "image2.jpg", 1999, 1999, "#60676a" ] } ] } [/block] Align the sticker in the handle’s sticker well in your preferred orientation and attach the edge of the sticker. [block:image] { "images": [ { "image": [ "https://files.readme.io/c726149-image5.jpg", "image5.jpg", 1999, 1999, "#5c5d5d" ] } ] } [/block] Once the stamp is aligned correctly you can remove the remainder of the backing material and press the sticker into place. [block:image] { "images": [ { "image": [ "https://files.readme.io/e75e650-image3.jpg", "image3.jpg", 1999, 1999, "#4e565c" ] } ] } [/block]
{"_id":"5e332aff5fe1cd3965383587","project":"55087b0f6065ed17002643ce","version":"5e332aff5fe1cd3965383588","category":"5e332aff5fe1cd3965383569","user":"5509cfc1e463aa3d000dd34a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-09-24T16:16:14.524Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"A very small percentage of consumer phones (less than 1%) presented for a stamp can have either a severely cracked screen or a non-standard thick screen protector. In order to serve these customers and enable the stamp event, we recommend using a fall back or work around with a button on the stamp screen (small) and a special 3-digit code. Below is a graphic example of a simple implementation of this approach.\n \nThere will be a little extra coding needed for this page, which could be in your stamp page templates, to facilitate this alternative method. The result from this manual authentication should point to the same page as the success page delivered after a normal stamping event.\n \nPlease note that any authentications using this work manual input work around will NOT show up in your SnowShoe Dashboard as this was not an actual stamp event. However, these transactions can be reported in your onsite analytics should you choose.\n \nObviously, staff will need to be trained to take this manual approach should a stamp not be recognized due to one of these issues. The secret code should remain known only to the staff and of course could be rotated periodically, with a little additional coding.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/422097e-manual_validation.png\",\n        \"manual_validation.png\",\n        3300,\n        2550,\n        \"#0eace2\"\n      ]\n    }\n  ]\n}\n[/block]\nAre you having issues with a specific device? [Contact us](doc:contact-email) with details.","excerpt":"","slug":"cracked-screens","type":"basic","title":"Cracked Screens & Screen Protectors","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Cracked Screens & Screen Protectors


A very small percentage of consumer phones (less than 1%) presented for a stamp can have either a severely cracked screen or a non-standard thick screen protector. In order to serve these customers and enable the stamp event, we recommend using a fall back or work around with a button on the stamp screen (small) and a special 3-digit code. Below is a graphic example of a simple implementation of this approach. There will be a little extra coding needed for this page, which could be in your stamp page templates, to facilitate this alternative method. The result from this manual authentication should point to the same page as the success page delivered after a normal stamping event. Please note that any authentications using this work manual input work around will NOT show up in your SnowShoe Dashboard as this was not an actual stamp event. However, these transactions can be reported in your onsite analytics should you choose. Obviously, staff will need to be trained to take this manual approach should a stamp not be recognized due to one of these issues. The secret code should remain known only to the staff and of course could be rotated periodically, with a little additional coding. [block:image] { "images": [ { "image": [ "https://files.readme.io/422097e-manual_validation.png", "manual_validation.png", 3300, 2550, "#0eace2" ] } ] } [/block] Are you having issues with a specific device? [Contact us](doc:contact-email) with details.
A very small percentage of consumer phones (less than 1%) presented for a stamp can have either a severely cracked screen or a non-standard thick screen protector. In order to serve these customers and enable the stamp event, we recommend using a fall back or work around with a button on the stamp screen (small) and a special 3-digit code. Below is a graphic example of a simple implementation of this approach. There will be a little extra coding needed for this page, which could be in your stamp page templates, to facilitate this alternative method. The result from this manual authentication should point to the same page as the success page delivered after a normal stamping event. Please note that any authentications using this work manual input work around will NOT show up in your SnowShoe Dashboard as this was not an actual stamp event. However, these transactions can be reported in your onsite analytics should you choose. Obviously, staff will need to be trained to take this manual approach should a stamp not be recognized due to one of these issues. The secret code should remain known only to the staff and of course could be rotated periodically, with a little additional coding. [block:image] { "images": [ { "image": [ "https://files.readme.io/422097e-manual_validation.png", "manual_validation.png", 3300, 2550, "#0eace2" ] } ] } [/block] Are you having issues with a specific device? [Contact us](doc:contact-email) with details.
{"_id":"5e332aff5fe1cd396538357f","title":"Contact Email","updates":[],"category":"5e332aff5fe1cd396538356b","excerpt":"","slug":"contact-email","link_external":false,"link_url":"","order":0,"project":"55087b0f6065ed17002643ce","body":"We're always around! If you have a specific question or just want to say hi, don't hesitate to reach out to us at [[email protected]](mailto:[email protected]).","githubsync":"","api":{"url":"","auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"user":"5509cfc1e463aa3d000dd34a","version":"5e332aff5fe1cd3965383588","sync_unique":"","type":"basic","__v":2,"createdAt":"2016-02-27T00:45:42.169Z","hidden":false,"isReference":false,"next":{"description":"","pages":[]},"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Contact Email


We're always around! If you have a specific question or just want to say hi, don't hesitate to reach out to us at [[email protected]](mailto:[email protected]).
We're always around! If you have a specific question or just want to say hi, don't hesitate to reach out to us at [[email protected]](mailto:[email protected]oestamp.com).