API Endpoints

Endpoints are suffixes at the end of a Basename (URL) that are used to call the sCloud API's.

Once you have created an application in the sCloud Developers dashboard and setup your preferred
development integration you can then make calls to the sCloud API's using any of the endpoints.

Most API Methods require a GET only, although some also accept a POST.

sCloud has a Powerful set of API endpoints, these are shown below in categories, each category has it's own group of endpoints.
1. A.I
2. Account
3. Cloud
4. Crypto
5. Enterprise
6. Iot
7. Monetize
8. S3 Object Storage (object storage) - Independent
9. Webmasters

sCloud's API

The sCloud API uses the {JSON} Protocol that returns JSON-encoded responses, an access token is needed for every API call, this ensures it's actually you or your application making the API requests.

Account

Account related API calls come under the Account category.

The account category has verious API Endpoints. (Account API Endpoints below)

Category: Account

GET /account_info

account_info

This endpoint shows all account related information.

account_info will only show information that your app has requested through the authorization flow with your defined (scope parameters). Refer to our allowed scopes for more information on scopes you are allowed to request.

SDK | php

$sCloud->API('account_info');//json format
//or individual account info
$sCloud->API('account_info')['username'];//json format

[account_info] raw JSON response - example values.

php javascript ajax java

{"storage_used":0,
"username":"skyGodinthecloud24",
"creation_date":"2024-02-18 17:41:32",
"verified":"1",
"account_type":"3",
"email":"user202433-app@scloud.live",
"devices":"5",
"ref_id":"null",
"iso_lang":"en",
"fname":"john",
"lname":"doe"}

//or
{"username":"skyGodinthecloud24"}

view raw

(JSON) RESPONSE PARAMETERS:

storage_used	Holds the users storage amount in available bytes.
username	holds the username of the authorized account.
fname	hold the users first name.
lname	holds the users last name.
creation_date	holds a timestamp of when the account was created.
verified	account verified 0=no 1=yes.
account_type	holds the user account type either a 1 for a FREE account or 3 for a PREMIUM account depending on what account type the user holds. if a 3 is present then there will be other values in the response, this will include premium_start and premium_expire timestamps.
email	Holds the users registered (alias) email address, (note this is not the real address but an sCloud issued email id) this helps protect the users email address.
iso_lang	ISO language code of registered user.
devices	integer of connected device count, you can use the account_devices API Endpoint to retrieve more information on the connected devices.
ref_id	returns the referal id if any of the referer service or user..

Category: Account

POST /account_create

account_create

This endpoint allows you to create an account with sCloud.

Each created account must be verified in order to be able to use the full functionality of sCloud.

(JSON) POST PARAMETERS:

email:	valid email address, otherwise. an error may be thrown.
username:	create a username for this account.
password:	md5() password hash or Plain text.
first_name:	first name of new user account.
last_name:	last name of new user account.
iso_lang:	(OPTIONAL) ISO language code of new user account.
ref_id:	(OPTIONAL) referer id usually yourself or your registered application (prefered value). If not set then the referer id of the Developer/creator of the application will be used by sCloud's API.

SDK | php

$new_account_values=array('email','username','password','first_name','last_name','iso_lang','ref_id');
$sCloud->API('account_create',$new_account_values);//json format

[account_create] raw JSON Object response - example values.

php javascript ajax java

{"username":"kingoftheclouds","created":"1715716412","result":"1","error":"0"}

view raw

(JSON) RESPONSE PARAMETERS:

result	if 1 then account was created successfully else if a 0 is present then there was an error creating an account, if so there should also be an error code returned (refer to our error codes for more information on error codes).
created	timestamp of when the account was created.

NOTE: Account verification is required in order to be able to use this newly created account, upon creating an account with this API call (/account_create) sCloud will automatically send an email to the registered email address asking to verify their account.

Category: Account

GET /account_delete

account_delete

This endpoint allows you to delete an account.

This is a two step process.

SDK | php

$sCloud->API('account_delete',(delete_token));//json format

[account_delete] raw JSON response.

php javascript ajax java

{ "result":"1"}"

view raw

(JSON) RESPONSE PARAMETERS:

result	1=success, 0=error.

Category: Account

GET /account_devices

account_devices

This endpoint retrieves information about all connected devices related to the authorized account.

with optional POST parameter as a int representing the amount to limit.

(Optional) POST PARAMETERS:

Int	Limit the amount of devices to display.

SDK | php

$sCloud->API('account_devices',10);//Limit to just 10 devices
//or
$sCloud->API('account_devices');

//or to get individual values
$sCloud->API('account_devices')['count'];

[account_devices] raw JSON response.

php javascript ajax java

{"result":"1",
"count":10,
"error":0,
"devicename":{
"1":"Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/124.0.0.0 Safari\/537.36",
"2":"Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/124.0.0.0 Safari\/537.36",
"3":"sCloud_app",
"4":"sCloud_app",
"5":"Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/124.0.0.0 Safari\/537.36",
"6":"Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/124.0.0.0 Safari\/537.36",
"7":"Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/124.0.0.0 Safari\/537.36",
"8":"sCloud_app",
"9":"Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/124.0.0.0 Safari\/537.36",
"10":"Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/124.0.0.0 Safari\/537.36",
"ip":{
"1":"381.673.113.987",
"2":"381.673.113.987",
"3":"381.673.113.987",
"4":"381.673.113.987",
"5":"381.673.113.987",
"6":"381.673.113.987",
"7":"381.673.113.987",
"8":"381.673.113.987",
"9":"381.673.113.987",
"10":"381.673.113.987"}

//or

{"result":"1",
"count":1,
"error":0,
"devicename":{
"1":"sCloud_app",
"ip":{
"1":"381.673.113.987",
}

view raw

(JSON) RESPONSE PARAMETERS:

result	1=data available, 0=no data to display.
count	Connected device count.
error	1=success, 0=error.
device_name	Device name of the connected device.
ip	Ip address of when this device connected/signed in to sCloud

Category: Account

GET /account_refs

account_refs

This endpoint retrieves all referer information if any, that is related to the authorized account.

SDK | php


$sCloud->API('account_refs');//json format

[account_refs] raw JSON response - example values.

php javascript ajax java

{"result":"1","error":"0","refs":"326"}

view raw

(JSON) RESPONSE PARAMETERS:

result	if 1 then data is available else if a 0 is present then no data available meaning no referers yet for this account).
refs	int count of referers for the account that is authorized with your application.

Cloud

Cloud related API calls come under the Cloud category.

The cloud category has verious Endpoints.(Cloud API Endpoints below)

Category: Cloud

POST /cloud_archive

cloud_archive

This endpoint allows you to Archive files in to zip folders .

....

POST PARAMETERS:

File	file path to archive.
encryption	security encryption method (AES-256).

SDK | php

$folder_to_archive="Files/BusinessInvoices";//example path replace with your actusl scloud file path.
$sCloud->API('cloud_archive',$folder_to_archive);

[cloud_archive] raw JSON response - example values.

php javascript ajax java

{"result":"1","error":"0","filename":"examplefile_video.mp4"}

view raw

(JSON) RESPONSE PARAMETERS:

result	1 success, 0 error/failure.
error	holds a error code if any.
filename	name of the file or files that was successfully uploaded.

Category: Cloud

POST /cloud_audio

cloud_audio

This endpoint allows you to retrieve audio files and all relevant information regarding these audio files..

....

POST PARAMETERS:

File	file path to archive.
encryption	security encryption method (AES-256).

SDK | php

$folder_to_archive="Files/BusinessInvoices";//example path replace with your actusl scloud file path.
$sCloud->API('cloud_archive',$folder_to_archive);

[cloud_archive] raw JSON response - example values.

php javascript ajax java

{"result":"1","error":"0","filename":"examplefile_video.mp4"}

view raw

(JSON) RESPONSE PARAMETERS:

result	1 success, 0 error/failure.
error	holds a error code if any.
filename	name of the file or files that was successfully uploaded.

Category: Cloud

POST /cloud_download

cloud_download

This endpoint allows you to configure and download a file or multiple files as a zip.

...

POST PARAMETERS:

File	the file or files that are to be uploaded. Multiple files can also be downloaded in just 1 call.	encryption	security encryption method (AES-256).

SDK | php

$upload_location="";
$sCloud->API('cloud_upload',$filetoupload,'AES-256',$upload_location);

[cloud_upload] raw JSON response - example values.

php javascript ajax java

{"result":"1","error":"0","filename":"examplefile_video.mp4"}

view raw

(JSON) RESPONSE PARAMETERS:

result	1 success, 0 error/failure.
error	holds a error code if any.
filename	name of the file or files that was successfully uploaded.

Category: Cloud

POST /cloud_upload

cloud_upload

This endpoint allows you to upload files or data BLOBs to the users sCloud storage account.

1. File storage.
2. Object storage.

All uploads require a encryption method.

POST PARAMETERS:

File	the file or files that are being uploaded. Multiple files can also be uploaded in just 1 call.
encryption	security encryption method (AES-256).
type	Upload type, (File) or (os) for object storage.

SDK | php

$upload_location="";
$sCloud->API('cloud_upload',$filetoupload,'AES-256',$upload_location);

[cloud_upload] raw JSON response - example values.

php javascript ajax java

{"result":"1","error":"0","filename":"examplefile_video.mp4"}

view raw

(JSON) RESPONSE PARAMETERS:

result	1 success, 0 error/failure.
error	holds a error code if any.
filename	name of the file or files that was successfully uploaded.