WebSNP Introduction - fullphat/snarl_network_protocol GitHub Wiki

WebSNP (previously known as SNP/HTTP) allows for quick and easy access to the Snarl API via standard HTTP requests.  Many requests can be run directly from a browser, making WebSNP very easy to learn and troubleshoot.  It's also platform and location agnostic: so long as you can send an HTTP request, you can use it to access Snarl.

Background

There are two varieties of WebSNP:

• v0 - The original version, now considered deprecated;
• v1 - Uses the same request format as v0, but returns responses formatted as JSON.  New applications should use this version; older applications should be migrated to V1.

There is also v2, a forthcoming RESTful implementation of WebSNP.

Notable Features

• HTTP based so no special client or server infrastructure required
• Provides full access to the Snarl API
• Easy to learn and troubleshoot using a standard browser or (for example) curl
• Supports request signing (authorisation) and encryption (requires Snarl R5.1 or later)

Next Steps

This short tutorial will get you up and running, and the Reference Guide provides more detail on the features available.