Introduction

The FileFactory API will enable you to access various features offered by the FileFactory website, via the HTTP/S GET and POST methods. Supported methods are listed in the menu to the left. New methods can be added when there's enough demand for them, so if functionality you require is missing from the API, please contact us.

Each account, by default, is restricted to a 5,000 request per hour threshold. Exceeding this will generate an error. If this limit is not sufficient for your use case, please contact us using the link above. This limit can be raised on a case-by-case basis.

Overview

The API supports both HTTPS and HTTP. We recommend using HTTPS wherever possible. All responses are returned in JSON. You can find an example request and a success/error response illustrated below:

https://api.filefactory.com/v1/method?param1=foo&param2=bar

{
  "type":"success",
  "result":{
    "foo":"bar",
    "baz":"qux"
  }
}

{
  "type":"error",
  "message":"Example error message",
  "code":123
}

When the response is "type":"error" it indicates that the request failed. This may be due to a server error, or an error specific to the request (i.e. incorrect file password, invalid file, etc). The only exception to this is the getFileInfo method, even if all of the file IDs entered were invalid, assuming the call completes successfully you will still be returned a "type":"success" response.

As a general rule, all file sizes, bandwidth and storage limits, etc, are displayed in bytes. All times and dates are either relative, or displayed as a timestamp (YYYY-MM-DD HH:MM:SS). All times are in CET.

All methods can throw a few generic errors (such as ERR_API_REQ_MISSING_PARAM). These are not listed under each method in the "Method Specific Errors" section. Please consult the Error Matrix for a complete list of possible errors.

Versions

The API Version is appended to the URL, between the FQDN and the method being called. For example: https://api.filefactory.com/v1/method?param1=...

Backwards incompatible changes will result in a new version being deployed. We strongly suggest utilizing the latest available API version.

Authenticating

You must have a valid FileFactory account to use most of the methods exposed by this API. Free and Premium accounts will both work, and are treated equally, except where the account type alters the method's return data. For example, running the getDownloadLink method with a Free account will return a free or TrafficShare download link, whereas running it with a Premium account will return a Premium download link.

We highly recommend specifying your session key when making requests, even for methods where it is not mandatory. Specifying it will increase your request limit threshold and allow us to more easily identify problems with your account, or the API, should they arise.

For information on authenticating, please consult the getSessionKey method, or the example below.

Example

This example illustrates how to obtain a session key, and obtain information on a list of file IDs. This assumes that the username and password entered are correct, and that two of the three files exist.

Step 1

"https://api.filefactory.com/v1/getSessionKey?email=example@filefactory.com&password=example

{
  "type":"success",
  "result":{
    "key":"b2eca18d2aa4f1fdbbbb4551a31c81aa6bcc4508"
  }
}

Step 2
Using the key obtained from the first query, we can now call getFileInfo.

https://api.filefactory.com/v1/getFileInfo?key=b2eca18d2aa4f1fdbbbb4551a31c81aa6bcc4508&file=1ep92k3t0fdz,5na8cbixx4aj,abcde12345

{
  "type":"success",
  "result":{
    "files":{
       "1ep92k3t0fdz":{
          "status":"online",
          "hash":"1ep92k3t0fdz",
          "name":"Tulips.jpg",
          "size":"620888",
          "added":"2014-01-23 06:49:39",
          "url":"http:\/\/www.filefactory.com\/file\/1lubbbam1odb\/n\/Tulips.jpg",
          "md5":"fafa5efeaf3cbe3b23b2748d13e629a1",
          "premiumOnly":true,
          "password":false
       },
       "5drpliy4x0bz":{
          "status":"online",
          "hash":"5drpliy4x0bz",
          "name":"Desert.jpg",
          "size":"845941",
          "added":"2014-01-23 06:49:46",
          "url":"http:\/\/www.filefactory.com\/file\/5na8cbixx4aj\/n\/Desert.jpg",
          "md5":"ba45c8f60456a672e003a875e469d0eb",
          "premiumOnly":false,
          "password":true
       },
       "abcde12345":{
          "status":"invalid"
       }
    }
  }
}

getSessionKey v1

Description

Session keys are valid for 15 minutes once generated. This expiration is extended automatically every time the key is used in a request. Please do not request a new session key before every request - doing so may result in your API access being temporarily suspended. In the event that the session key has expired, you will receive a specific error (either ERR_API_KEY_INVALID (710) or ERR_API_KEY_EXPIRED (711))

Example

https://api.filefactory.com/v1/getSessionKey?email=example@filefactory.com&password=example&authkey=1234567890

{
  "type":"success",
  "result":{
    "key":"b2eca18d2aa4f1fdbbbb4551a31c81aa6bcc4508"
  }
}

Request Parameters

Method Specific Errors

getMemberInfo v1

Description

Example

https://api.filefactory.com/v1/getMemberInfo?key=b2eca18d2aa4f1fdbbbb4551a31c81aa6bcc4508

{
  "type":"success",
  "result":{
    "email":"example@filefactory.com",
    "accountType":"premium",
    "expiryDate":"YYYY-MM-DD HH:MM:SS",
    "expiryMs":1234567890,               // Milliseconds to account expiration
    "joined":"YYYY-MM-DD HH:MM:SS",
    "fileCount":"12345",
    "storageLimit":"1099511627776",      // Bytes
    "storageUsed":107374182400,          // Bytes
    "directDownloads":true,              // Boolean
    "trafficShare":false,                // Boolean
    "trafficShareUsed":null,             // Bytes, if trafficShare === true
    "trafficShareLimit":null             // Bytes, if trafficShare === true
  }
}

Request Parameters

Method Specific Errors

getFileInfo v1

Description

Example

https://api.filefactory.com/v1/getFileInfo?key=b2eca18d2aa4f1fdbbbb4551a31c81aa6bcc4508&file=1ep92k3t0fdz,5na8cbixx4aj,abcde12345

{
  "type":"success",
  "result":{
    "files":{
       "1ep92k3t0fdz":{
          "status":"online",             // Either 'online', 'offline', 'invalid'
          "hash":"1ep92k3t0fdz",
          "name":"Tulips.jpg",
          "size":"620888",               // Bytes
          "added":"2014-01-23 06:49:39",
          "url":"http:\/\/www.filefactory.com\/file\/1lubbbam1odb\/n\/Tulips.jpg",
          "md5":"fafa5efeaf3cbe3b23b2748d13e629a1",
          "premiumOnly":true,            // Boolean
          "password":false               // Boolean
       },
       "5drpliy4x0bz":{
          "status":"online",
          "hash":"5drpliy4x0bz",
          "name":"Desert.jpg",
          "size":"845941",
          "added":"2014-01-23 06:49:46",
          "url":"http:\/\/www.filefactory.com\/file\/5na8cbixx4aj\/n\/Desert.jpg",
          "md5":"ba45c8f60456a672e003a875e469d0eb",
          "premiumOnly":false,
          "password":true
       },
       "abcde12345":{
          "status":"invalid"
       }
    }
  }
}

Request Parameters

Method Specific Errors

getDownloadLink v1

Description

Example

https://api.filefactory.com/v1/getDownloadLink?key=b2eca18d2aa4f1fdbbbb4551a31c81aa6bcc4508&file=1ep92k3t0fdz

{
  "type":"success",
  "result":{
    "url":"http:\/\/s1.filefactory.com\/get\/p\/1ep92k3t0fdz\/f18874b7bfbe5104\/Tulips.jpg",
    "name":"Tulips.jpg",
    "size":"620888",
    "linkType":"premium",                // Either 'premium', 'trafficshare', or 'free'
    "delay":0                            // Wait time - only > 0 if linkType == free
  }
}

Request Parameters

Method Specific Errors

Error Matrix

The following is a list of all of the possible error codes that the API can return.

Sample Code

Sample code will be coming soon.