SCL API is based on RESTful which supports a bunch of different request/response formats, including XML, JSON and serialised PHP. By default, the class will check the URL and look for a format either as an extension or as a separate segment.

Default API output content type is json, the following examples is to change output content type

This means your URLs can look like this:

http://example.com/api/v1/dashboard.json
http://example.com/api/v1/dashboard?format=json

This can be flaky with URI segments, so the recommend approach is using the HTTP Accept header:

$ curl -H "Accept: application/json" http://example.com/api/v1/dashboard

To access any of API methods you will need retrieve your access token which you will use later for in HTTP Headers for every method call.

Supported request to Auth method is GET

To retrieve accessCode & User Information http://example.com/api/v1/auth?identity=Email&password=Pass&objectId=ParseObjectId

make sure to add accessCode to your ACCESS-CODE header in every method request.

To authenticate you must set header name “ACCESS-CODE” to the user retrieved accessCode. in order to call any other functions such as student or parent you must always set the header for any method call.

Curl Example

$ curl -X POST -H "X-ACCESS-CODE: user_accessCode" http://example.com/api/v1/

jQuery Example

$.ajaxSetup({
    headers: { 'X-ACCESS-CODE': 'user_accessCode' }
});

OR

$.ajax({
    url: 'http://example.com/api/v1/dashboard',
    headers: { 'X-ACCESS-CODE': 'user_accessCode' }
});

Calling user information method is GET action & must be Authenticated.

URL Example http://example.com/api/v1/user

Calling user information method is POST action & must be Authenticated.

URL Example http://example.com/api/v1/upload_avatar

var form = new FormData();
form.append("avatar", "Sasa.png");
 
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://example.com/api/v1/upload_avatar",
  "method": "POST",
  "headers": {
    "access-code": "YOUR_ACCESS_CODE"
  },
  "processData": false,
  "contentType": false,
  "mimeType": "multipart/form-data",
  "data": form
}
 
$.ajax(settings).done(function (response) {
  console.log(response);
});

{
  "success": "http://example.com/assets/uploads/avatar/6bb8aae67ff8.png"
}

{
  "error": "The filetype you are attempting to upload is not allowed.",
  "code": 1031
}

Calling update_user method is POST action & must be Authenticated. This method will allow you to update User full name, email and password.

URL Example http://example.com/api/v1/update_user

Parameters

This command response is use exactly same output as in Auth Response, make sure to save the new accessCode output to your database for the future use.

Calling unregister_device method is GET action & must be Authenticated. This method will allow you to remove/un-register Device from Push Notification, required in Logout.

URL Example http://example.com/api/v1/unregister_device?objectId=UrStoredParseObjectId

Parameters

cURL Example

curl -X GET -H "access-code: YourAccessCode" -H "Cache-Control: no-cache" -H 'http://example.com/api/v1/unregister_device?objectId=UrStoredParseObjectId'

Response

{
"success":"Device been successfully removed."
}

The following HTTP Status description to guide you which we do currently used. for official HTTP Status codes visit ietef.org