Superfy Platform API Documentation

Welcome to the Superfy Platform API Documentation

Choose what API documentation you need in table of contents above.

Every API documentation will display:

brief explanation of the API
short URL (exclude domain name)
authentication: require or not
required parameter (exclude authentication parameter)
optional parameter
possible return HTTP status code
success return value

Before continue, please read some explanation and standards below.

API Standards

Payload

All API will use POST method with JSON payload as its parameter. So, please set "Content-Type" header as application/json

Parameters

There are 4 types of parameters:

Required parameter (in URL) -> indicates by :variablename. It should change :variablename in the API URL.
Required parameter (POST) -> should be passed via POST method
Optional parameter (POST) -> should be passed via POST method
Optional parameter (GET) -> should be passed via GET method, embedded in the URL like api/url/?variablename1=value1&variablename2=value2

Usually, all parameters should be passed via method mentioned, or use POST method by default if not mentioned.

Some "Optional parameter" in certain API might use GET method. If it uses GET method, there will be extra notes or explanation below its section title ("Optional parameter").
For example: "All optional parameters use GET method. So it should be embedded in the URL, e.g: api/projects/list?q=project&o=projectName" in Get Available Projects API.

If there is no extra notes or explanation like mentioned above, please always use POST method.

Date Format

All "date" field returned from API will use server timezone in integer format (time measured in the number of seconds since the Unix Epoch).
To convert it to use user timezone, please calculate it with "timezoneOffset" and "server_timezoneOffset" got from user register, authorize, or request reset password. Example code to convert date returned from API to user timezone:

$offset_date_to_server = ($timezoneOffset - $server_timezoneOffset) * 60; // second
$date = $date + $offset_date_to_server;

Default coordinates:

latitude: -27.4711475372317
longitude: 153.023132324219

Location: Brisbane, Queensland, Australia.

Return or Result Format

All API will return a standard HTTP status code and a JSON string with standard format.

Standard HTTP status code:

200: success
201: data created successfully
400: general error
401: error related with deviceID and token
404: one of parameters is invalid or is not found in database
405: wrong method
500: server error or application configuration error

Example of standard JSON string format returned from API call:

{
	"status":"error",
	"message":["Username and Password combination are not found"]
}

Explanation:

status: contain string "error" or "success"
message: contain an array of error message (if status = "error"), or contain data from API call which will be explained in each API

Authentication Parameter to Access API which Require Authentication

You need to pass this parameters (including other API parameters) in your JSON payload for every API call that needs authentication:

{
	"deviceID": "some device ID value here",
	"token": "token you get from Authorize API call (also known as login API)"
}