Overview

The file upload API is an interface which can be used in your own applications to securely upload, manage and download files externally from this website.

API compatibility

This API will evolve over time when access to other data within the system is made available. However, none of the current endpoints or response values will change. You can write your integration code knowing that it will not be affected by future updates unless there is a bug or security fix.

More functionalities will be added soon.

SSL/HTTPS recommended

All requests to the API requires SSL.

UTF-8 encoding

Every string passed to and from the API needs to be UTF-8 encoded.

HTTP Method

All methods are done using POST unless otherwise stated.

Date format

All date/times are based on UTC timezone.

All date/times in the API are strings in the following format:

Y-m-d H:i:s

For example:

2024-11-21 06:59:07

File size

All file sizes are provided in bytes.

1024 Bytes is equal to 1 Megabytes in our system.

API Path

All requests are sent to the follow path:

https://mirrorace.com/api/v1/

Response

All information is included in the body of the return call, JSON-formatted.

Response Content

All JSON response contains two keys. 'status' and 'result'.

Sample JSON Response:

{
	"status": "<status>",
	"result": "<informational message. varies depending on the request>"
}

Details:

status:

"error" or "success"

result:

Gives response in case of success or detailed information in case of an error. Might hold an array of data or just a boolean true/false, depending on the request.

Authentication

Each and every request requires an API key and API token which is unique for each and every user.

API key and API token can be regenerated in case of exposure.

Credentials

Get your API Credentials from here.

Upload

Get variables required for uploading file directly or via remote url.

URL Structure

https://mirrorace.com/api/v1/file/upload

Parameters

Response

Returns an array of variables required for uploading file directly or via remote url.

Sample Successful JSON Response:

{
	"status": "success",
	"result": {
		"server": "https://m1.mirrorace.com",
		"server_file": "https://m1.mirrorace.com/api/v1/upload",
		"server_remote": "https://m1.mirrorace.com/api/v1/upload/remote",
		"cTracker": "0123456789abcdefabcdefabcdefabcd",
		"mirrors": {
			"1": true,
			"2": true,
			"3": true
		},
		"default_mirrors": [
			"1",
			"2",
			"3"
		],
		"max_chunk_size": "99999988",
		"max_file_size": "10737418240",
		"max_mirrors": "100",
		"upload_key": "0123456789abcdefabcdefabcdefabcd",
		"upload_key_expiry": "2024-11-21 07:59:07"
	}
}

File Info

Check the status of a file, e.g. if the file exists.

URL Structure

https://mirrorace.com/api/v1/file/info

Parameters

Response

Returns an array of status of each file.

Sample Successful JSON Response:

{
	"status": "success",
	"result": {
		"7hzy": {
			"id": "735848",
			"name": "Space Man Jelly.jpg",
			"slug": "7hzy",
			"size": "35892",
			"url": "https://mirrorace.com/m/7hzy",
			"status": "active"
		},
		"7hzz": {
			"id": "null",
			"name": "null",
			"slug": "null",
			"size": "null",
			"url": "null",
			"status": "not found"
		}
	}
}

Upload File Direct

Provides an interface to upload files.

All Upload requests shall be multipart/form-data encoded.

MirrorAce only supports chunk upload for files larger than Maximum chuck size. A single request should not upload more than Maximum chuck size. Note: Maximum chuck size will be returned from file/upload method.

Maximum chuck size as of now is 99999995 Bytes.

For files larger then the Maximum chuck size, files should be sent in chunks with proper "Content-Length" and "Content-Range" headers.

Every parameter should be sent with every chunk.

Example code

Login to see Example code.

URL Structure

https://mirrorace.com/api/v1/upload

Parameters

Response

Returns an array of file upload status.

Sample Successful Upload Complete JSON Response (If last or only chunk):

{
	"status": "success",
	"result": {
		"name": "Space Man Jelly.jpg",
		"size": "35892",
		"slug": "7hzy",
		"url": "https://mirrorace.com/m/7hzy",
		"info": "complete"
	}
}

Sample Successful Upload Pending JSON Response (If requires more chunks):

{
	"status": "success",
	"result": {
		"name": "Space Man Jelly.jpg",
		"size": "35892",
		"info": "continue"
	}
}

Upload File Remote

Provides an interface to upload via remote URL.

URL Structure

https://mirrorace.com/api/v1/upload/remote

Parameters

Response

Returns an array of file upload status.

Sample Successful JSON Response:

{
	"status": "success",
	"result": {
		"name": "Space Man Jelly.jpg",
		"size": "35892",
		"slug": "7hzy",
		"url": "https://mirrorace.com/m/7hzy",
		"info": "complete"
	}
}