FileLink API

With the FileLink API, you can automate creating FileLinks from other applications using the API.

Create FileLink

Same as with the Filedrop and the standard messages based sending of files, you need to upload the files to the LiquidFiles server first and retrieve the attachment id before calling this File Request API, please see the Attachments API for instructions how to upload the files.

The http response codes are 200 OK if the File Request was successful, and 422 Unprocessable Entity if anything went wrong. In case of an error, there's also an error message with what went wrong.

Example Request in JSON

cat <<EOF | \
  curl -X POST --user Y9fdTmZdv0THButt5ZONIY:x \
       -H "Accept: application/json" \
       -H "Content-Type: application/json" \
       -d @- https://liquidfiles.company.com/link
{"link":
  {
    "attachment":"fHbIuSIou38Txc0jVrobEp",
    "expires_at":"2017-01-01",
    "download_receipt":true,
    "require_authentication":true
  }
}
EOF

Example Response in JSON

{"link":
  {
    "id":"ZLa8RSQF2XDyrcVVMbrsNY",
    "filename":"screenshot.png",
    "send_download_confirmation":true,
    "require_authentication":true,
    "size":147874,
    "size_human":"144 KB",
    "expires_at":"2017-01-03",
    "url":"https://liquidfiles.company.com/link/ZLa8RSQF2XDyrcVVMbrsNY",
    "created_at":"2016-12-19T21:56:08.719Z",
    "updated_at":"2016-12-19T21:56:08.719Z"
  }
}

Uploading Files

Uploading files to create a FileLink is very similar to the sending messages API, with the only change is the URL for the file upload. For detailed instructions how to to upload the file(s), please see the Attachments API.

Response

As a response to a successful File Upload you will receive an attachment response with the attributes outlined in the Attachment Attributes documentation.

Example: Create FileLink using bash and curl

#!/bin/bash

# Some nice variables
api_key="Y9fdTmZdv0THButt5ZONIY"
server="https://liquidfiles.example.com"

# Uploading the actual file and get attachment id for the file
attachment_id=`curl -X POST --user "$api_key:x" \
  -H "Accept: application/json" \
  --data-binary @bigfile.zip $server/link/attachments/upload | \
  jq .attachment.id`

# Create the FileLink
cat <<EOF | curl -s -X POST --user "$api_key:x" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d @- $server/link

{"link":
  {"attachment":"$attachment_id"}
}
EOF

List FileLinks

You can list the available FileLinks using a GET request to /link like this:

Response

The response will be a JSON Array with all available FileLinks.

Example: List FileLinks using bash and curl

#!/bin/bash

# Some nice variables
api_key="Y9fdTmZdv0THButt5ZONIY"
server="https://liquidfiles.example.com"

curl -X GET --user "$api_key:x" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     $server/link?limit=2

Example Response

{"links":
  [
    {
      "id":"pOIcoQ1NbJ8Lmp19hd9Vo3",
      "filename":"screenshot.png",
      "send_download_confirmation":true,
      "require_authentication":true,
      "size":147874,
      "size_human":"144 KB",
      "expires_at":"2017-01-03",
      "url":"https://test.host/link/pOIcoQ1NbJ8Lmp19hd9Vo3",
      "created_at":"2016-12-19T21:54:54.000Z",
      "updated_at":"2016-12-19T21:54:54.000Z"
    },
    {
      "id":"ZLa8RSQF2XDyrcVVMbrsNY",
      "filename":"another screenshot.png",
      "send_download_confirmation":true,
      "require_authentication":true,
      "size":147874,
      "size_human":"144 KB",
      "expires_at":"2017-01-03",
      "url":"https://lfapp.dev/link/ZLa8RSQF2XDyrcVVMbrsNY",
      "created_at":"2016-12-19T21:56:08.000Z",
      "updated_at":"2016-12-19T21:56:08.000Z"
    }
  ]
}

Deleting a FileLink

Example Delete FileLink using bash and curl

#!/bin/bash

# Some nice variables
api_key="Y9fdTmZdv0THButt5ZONIY"
server="https://liquidfiles.example.com"

curl -X DELETE --user "$api_key:x" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     $server/link/tzMNVK0sbpXFFlld65s4Ly

Response Code

There are three possible response codes as a result of the request:

Updating Parameters

When you have added a FileLink and you want to change some parameters such expiration date, authentication and download notifications.

Updating Require Authentication

Example Update Require Authentication using bash and curl

#!/bin/bash

# Some nice variables
api_key="Y9fdTmZdv0THButt5ZONIY"
server="https://liquidfiles.example.com"

curl -X PUT --user "$api_key:x" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -d '{"require_authentication":false}' \
     $server/link/tzMNVK0sbpXFFlld65s4Ly/update_authentication

Response Code

There are three possible response codes as a result of the request:

Updating Download Notification

Example Update Download Notification using bash and curl

#!/bin/bash

# Some nice variables
api_key="Y9fdTmZdv0THButt5ZONIY"
server="https://liquidfiles.example.com"

curl -X PUT --user "$api_key:x" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -d '{"send_download_confirmation":false}' \
     $server/link/tzMNVK0sbpXFFlld65s4Ly/update_download_confirmation

Response Code

There are three possible response codes as a result of the request:

Updating Expires At

Example Update Expires At using bash and curl

#!/bin/bash

# Some nice variables
api_key="Y9fdTmZdv0THButt5ZONIY"
server="https://liquidfiles.example.com"

curl -X PUT --user "$api_key:x" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -d '{"expires_at":"2015-04-18"}' \
     $server/link/tzMNVK0sbpXFFlld65s4Ly/update_expires_at

Response Code

There are three possible response codes as a result of the request: