Stamplay JavaScript SDK
This library gives you access to the powerful Stamplay cloud platform from your JavaScript app. For more info on Stamplay and its features, see the website or the JavaScript guide
Installation
The SDK is available for on NPM, Bower and on our CDN.
npm
Using$ npm install -g stamplay-sdk
bower
Using$ bower install -g stamplay-js-sdk
To get started import the library in your project and initialize it by calling init
function with your appId
<script src="https://drrjhlchpvi7e.cloudfront.net/libs/stamplay-js-sdk/2.1.3/stamplay.min.js"></script><script> Stamplay.init("APPID"); </script>
How to use it
Register a new user:
var data = "email":"john@stamplay.com" "password":"john123"StamplayUser
Store data using Objects:
var data = "description":"A description" "title":"New title"Stamplay
Skip the callback to get a promise back
var data = "description":"A description" "title":"New title"Stamplay
Available components
This JavaScript SDK expose the following components:
- User
save(data, [callback])
get(data, [callback])
getById(id, data, [callback])
remove(id, [callback])
update(id, data, [callback] )
currentUser([callback])
login(data, [callback])
socialLogin(provider)
signup(data, [callback])
logout(async)
resetPassword(data, [callback])
getRoles([callback])
getRole(id, [callback])
setRole(id, roleId, [callback])
- Object
save(data, [callback])
get(data, [callback])
getById(id, data, [callback])
remove(id, [callback])
update(id, data, [callback])
patch(id, data, [callback])
findByCurrentUser([attr], [data], [callback])
upVote(id, [callback])
downVote(id, [callback])
rate(id, rate, [callback])
comment(id, text, [callback])
push(id, attribute, data, [callback])
- Code Block
post(data, queryParams, [callback])
get(queryParams, [callback])
put(data, queryParams, [callback])
patch(data, queryParams, [callback])
delete(queryParams, [callback])
- Webhook
post(data, [callback])
- Stripe
charge(userId, token, amount, currency, [callback])
createCreditCard(userId, token, [callback])
createCustomer(userId, [callback])
createSubscriptionuserId, planId, [callback])
deleteSubscription(userId, subscriptionId, options, [callback])
getCreditCard(userId, [callback])
getSubscription(userId, subscriptionId, [callback])
getSubscriptions(userId, options, [callback])
updateCreditCard(userId, token, [callback])
updateSubscription(userId, subscriptionId, options, [callback])
Also this components the sdk have some support objects to help you in common operation:
- Query
greaterThan(attr, value)
greaterThanOrEqual(attr, value)
lessThan(attr, value)
lessThanOrEqual(attr, value)
pagination(page, per_page)
between(attr, value1, value2)
equalTo(attr, value)
notEqualTo(attr, value)
exists(attr)
notExists(attr)
sortAscending(attr)
sortDescending(attr)
populate()
populateOwner()
select(attr,...)
regex(attr, regex, options)
near(type, coordinates, maxDistance, minDistance)
nearSphere(type, coordinates, maxDistance, minDistance)
geoIntersects(type, coordinates)
geoWithinGeometry(type, coordinates)
geoWithinCenterSphere(coordinates, radius)
or(query,..)
exec([callback])
Build
To build a production ready library you need to have NPM and Bower installed and then run those two commands:
npm install && bower installgrunt build
You can also download this project and using all the precompiled files in src folder
Contributing
- Fork it ( https://github.com/[my-github-username]/stamplay-js-sdk/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
One more thing
Go to API Reference to see a lot of examples. Enjoy!