Initiation

First, you need to create your own api key to use JavaScript SDK. Go to our website for this. quescheetah.com

Our SDK file requests to REST API Server by ajax. It's made with pure JavaScript so you don't need to install other library.

    var config = {
        "apiKey": "your-api-key",
        "callBackUrl": "your-callback-url"
    }

    var qc = new QuesCheetah(config);

Request authentication allows "api-key" header method or "jwt" with "kid" header method.

Options

apiKey

• Default : null
• Your api key value for request to REST API Server.

receiveRealtimeResponse

• Default : false
• When this option is "true", SDK connects to our socket server and realtime data could be transmitted.
• This feature is not implemented on our website yet.

callBackUrl

• Default : null
• Client origin url that request is coming from.

baseUrl

• Default : http://www.quescheetah.com/v1/
• Destination url for the request

Methods

"params" argument has the same format as REST API request format. Check the format in REST API document

Group

1. create a group question

Create many questions. These questions are grouped together as group_name.

REST API URL = "/groups"

Method = "POST"

    qs.createGroup(params, successCallback, errorCallback);

2. delete a group question

Delete a group with all related question, answer and useranswer data.

REST API URL = "groups/{groupId}"

Method = "DELETE"

    qs.deleteGroup(params, successCallback, errorCallback);

3. get a group question

Get a group with all related question, answer and useranswer data.

REST API URL = "groups/{groupId}"

Method = "GET"

    qs.getGroup(params, successCallback, errorCallback);

Question

1. make a question

Make a single question.

REST API URL = "questions"

Method = "POST"

    qs.createQuestion(params, successCallback, errorCallback);

2. get a question

Get a question data.

REST API URL = "questions/{questionId}"

Method = "GET"

    qs.getQuestion(params, successCallback, errorCallback);

3. update a question

update a question data.

REST API URL = "questions/{questionId}"

Method = "PUT"

    qs.updateQuestion(params, successCallback, errorCallback);

4. delete a question

delete a question data with all answer and useranswer data.

REST API URL = "questions/{questionId}"

    qs.deleteQuestion(params, successCallback, errorCallback);

Answer

1. make a new answer of specific question

Add a new answer to the question.

REST API URL = "questions/{questionId}/answers"

    qs.createAnswer(params, successCallback, errorCallback);

2. get one answer data of the question

Get answer data of answerNum.

REST API URL = "questions/{questionId}/answers/{answerNum}"

    qs.getAnswer(params, successCallback, errorCallback);

3. delete one answer data of the question

Delete answer data of answerNum.

REST API URL = "questions/{questionId}/answers/{answerNum}"

    qs.deleteAnswer(params, successCallback, errorCallback);

Useranswer

1. create useranswer

Used when new user answers the question.

REST API URL = "questions/{questionId}/answers/{answerNum}/useranswers"

    qs.createUserAnswer(params, successCallback, errorCallback);

2. update useranswer

Change the number which user answered.

REST API URL = "questions/{questionId}/answers/useranswers/{uniqueUser}"

    qs.updateUserAnswer(params, successCallback, errorCallback);

3. delete useranswer

Delete the useranswer data of uniqueUser.

REST API URL = "questions/{questionId}/answers/useranswers/{uniqueUser}"

    qs.deleteUserAnswer(params, successCallback, errorCallback);