1. Getting Started

jsrocket edited this page Jun 14, 2017 · 13 revisions

Table Of Contents

Overview

jsRocket was created to be a scalable feature filled back-end to your Javascript application. By including a single JS library you application can instantly have access to authentication, a cloud database, sending email, secure hosted functions, calling 3rd party APIs and more.

Common Themes Found In The JS SDK

This section will introduce you to common themes and standards you will encounter while integrating with jsRocket.


Function Parameters

All functions parameters are passed in as a JSON object. Detailed descriptions of the required object are available in the respective documentation page.


Response Objects

Every response object will contain three top level keys.

  • data OBJECT When the response is successful, the data object will contain the information requested from jsRocket.
  • details STRING In the event of an error and the success value is set to FALSE, details will contain information about the error.
  • success BOOLEAN Will return a TRUE for successful requests and FALSE when an error has occurred.

Examples

Success Response

{
"data":{
	"user_key":"310d6cae68fefc5ce0e751a99952bd9f24209363",
	"email":"user@email.com"
},
"details":"",
"success":true
}

Error Response

{
"data":{},
"details":"data not found",
"success":false
}

Getting Started With The SDK

Step 1: Sign up for a jsRocket account at [coming soon]


Step 2: Include the jsRocket library

You can download the jsrocket.min.js file from this repo and host it locally or include the link to the file on S3 at https://s3.amazonaws.com/jsrocket/jsrocket.min.js

<script type="text/javascript" src="https://s3.amazonaws.com/jsrocket/jsrocket.min.js"></script>

Step 3: Initiate jsRocket

Include the following init function call inside of your document ready event.

jsRocket.init("YOUR-APP-KEY-HERE",function(){
    //Callback will return when jsRocket is fully loaded
});

Example

$('document').ready(function(){
    jsRocket.init("YOUR-APP-KEY-HERE",function(){

        // Insert your application code here

    });
});
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.