Retsly core SDK. Useful for clientside integration with Retsly.
For a higher-level backbone component, use retsly/retsly-js-backbone.
For a server side js integration use retsly/js-sdk.
To use this you will need to create an application of Retsly
You can learn more from our API Docs.
- Include the hosted retsly-js-sdk in your
<!-- Include the SDK --><!-- Content --><!-- Get listing data from "test" vendor -->
If you are testing on
localhost. It is important to update your Http Referrer Domain and OAuth settings in your application settings to match you testing url.
Use with Browserify
- First install with npm:
$ npm install retsly-js-sdk
- Next, anywhere that you want to use the retsly-js-sdk simply
require('retsly-js-sdk'). Below is an example of using this in
/*** main.js*/// Dependencyvar Retsly = ;var retsly = <YOUR_CLIENT_ID> <YOUR_JS_TOKEN>;retsly;
- When you are ready to start compiling, follow the general Browserify procedure. Here is an example with compiling
$ browserify main.js -o target.js
For More information on how to use browserify, go to the docs
- Finally, drop a single
<script>tag into your html file with the compiled script:
Now you should be able to make use of all of the Retsly API endpoints via the
Build from source
Clone the repo and build the standalone file
$ git clone https://github.com/Retsly/retsly-js-sdk$ cd retsly-js-sdk$ make dist
Include in your project:
This will export the client SDK as an AMD or CommonJS module,
Use with Phonegap
You'll need to add rets.ly and rets.io to your application's whitelist. See the Whitelist Guide for instructions.
(The MIT License)
Copyright (c) 2014 Retsly Software Inc email@example.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.