Sending files using the Filedrop

Filedrop Info Request

This Filedrop Info Request is unauthenticated, all other requests are authenticated.

In order to make client side validation possible when sending through a Filedrop, you can start by running a Filedrop Info Request like this:

This will respond with details about the Filedrop that can be used to facilitate the Filetransfer (the Filedrop api key) and the file type and file size limitations so that you can implement client side validations of those without having to upload a file.

Example using curl with response

curl -s -H "Accept: application/json" https://liquidfiles.company.com/filedrop/test_filedrop

{"filedrop":
  {
    "api_key":"qiXT9Za7HcXhMTJDBo2oe5",
    "name":"Filedrop Test",
    "limited_extensions":"doc, docx, xls, xlsx, ppt, pptx, png, gif, jpg, jpeg, pdf, zip",
    "blocked_extensions":"",
    "max_upload_size":250
  }
}

If you wanted to just grab the API key, you could run the following:

curl -s -H "Accept: application/json" https://liquidfiles.company.com/filedrop/test_filedrop | ruby -rjson -e 'puts JSON.parse(STDIN.read)["filedrop"]["api_key"]'

Uploading Files

The sending of files 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 Using Curl

There's a couple of things to note in the example,

#!/bin/bash

# Some variables
filedrop_url=https://liquidfiles.company.com/filedrop/filedrop_test

# retrieve the Filedrop API key
filedrop_api_key=`curl -s -H "Accept: application/json" $filedrop_url | ruby -rjson -e 'puts JSON.parse(STDIN.read)["filedrop"]["api_key"]'`

# Send the file
attachment_id=`curl -s -X POST -H "Accept: application/json" -H "Content-Type: image/jpeg" --data-binary "@imagefile.jpg" --user "$filedrop_api_key:x" $filedrop_url/attachments/upload?filename=imagefile.jpg`

Creating/Submitting the Filedrop

Complete example, getting the API key, uploading a file and submitting the Filedrop, using curl

#!/bin/bash

# Variables
filedrop_url=https://liquidfiles.company.com/filedrop/filedrop_test

# retrieve the Filedrop API key
filedrop_api_key=`curl -s -H "Accept: application/json" $filedrop_url | jq .filedrop.api_key`

# Uploading the file
attachment_id=`curl -s -X POST -H "Accept: application/json" --data-binary "@bigfile.zip" --user "$filedrop_api_key:x" $filedrop_url/attachments/upload?filename=bigfile.zip | jq .attachment.id`

cat <<EOF | curl -s -X POST -H "Accept: application/json" -H "Content-Type: application/json" -d @- $filedrop_url
{"message":
  {
    "from":"someone@somewhere.com",
    "subject":"test subject",
    "message":"Please let me know what you think!",
    "attachments":["$attachment_id"]
  }
}
EOF

Response

The Filedop API response is basically a simple OK message that the message has been delivered ok. You can also check for HTTP status code 200. If everything is ok, you should see the following output:

{"message":{"status":"Filedrop message sent successfully"}}

If there's an error, you will see a standard JSON error message like:

{"errors":["You need to attach at least one file"]}