Shares

Get List of Shares

GET https://account.sf-api.com/sf/v3/Shares 

Retrieve all outstanding Shares of the authenticated user

Returns: List of Shares created by the authenticated user

Get Share

GET https://account.sf-api.com/sf/v3/Shares(id)?includeExpired=false 

Retrieve a single Share entity. Public share access will now require authentication for programmatic access for better security. If the Share is expired the endpoint will respond with 404 Not Found, unless `includeExpired` is set to true. The creator of the Share will fetch an expired Share, regardless of the `includeExpired` value

Returns: A single Share

Get Recipients of a Share

GET https://account.sf-api.com/sf/v3/Shares(id)/Recipients 

Retrieve the list of Recipients in the share. Recipients represent the target users of the Share, containing access information, such as number of times that user downloaded files from the share. Each Recipient is identified by an Alias, which is an unique ID given to each user - allowing tracking of downloads for non-authenticated users.

Returns: A feed of Share Aliases representing recipients of the Share

Get Recipient of a Share

GET https://account.sf-api.com/sf/v3/Shares(parentid)/Recipients(id) 

Retrieve a single Share Recipient identified by the alias id.

Returns: A Share Alias representing a single recipient of the Share

Create Recipient for a Share

POST https://account.sf-api.com/sf/v3/Shares(parentid)/Recipients?Email=email&FirstName=firstName&LastName=lastName&Company=company 

Creates a Recipient User for a Share that requires user information

Returns: A Share Alias representing a single recipient of the Share

Get Items of a Share

GET https://account.sf-api.com/sf/v3/Shares(id)/Items 

Retrieve the list of Items (files and folders) in the Send Share.

Returns: A feed of Items of the Share

Get Items of a Send Share

GET https://account.sf-api.com/sf/v3/Shares(shareid)/Items(itemid) 

Retrieve a single Item in the Send Share

Returns: An item in the Share

Get Thumbnail of a Share Item

GET https://account.sf-api.com/sf/v3/Shares(shareid)/Items(itemid)/Thumbnail?size=75&redirect=true 

Retrieve a thumbnail link for the specified Item in the Share.

Returns: A 302 redirection to the Thumbnail link

Get List of Protocol Links of a Share item

GET https://account.sf-api.com/sf/v3/Shares(shareid)/Items(itemid)/ProtocolLinks(platform) 

Returns: A list of protocol links depending on the input parameter 'platform', 404 (Not Found) if not supported by the item

Downloads Share Items

GET https://account.sf-api.com/sf/v3/Shares(shareid)/Download 

GET https://account.sf-api.com/sf/v3/Shares(shareid)/Download?Name=username&Email=user@company.com&Company=Acme 

GET https://account.sf-api.com/sf/v3/Shares(shareid)/Download?id=itemid 

GET https://account.sf-api.com/sf/v3/Shares(shareid)/Download(itemid) 

Downloads items from the Share. The default action will download all Items in the Share. If a Share has a single item, the download attachment name will use the item name. Otherwise, the download will contain a ZIP archive containing all files and folders in the share, named Files.zip.

To download Shares that require authentication, make sure this request is authenticated. To download shares that require require user information, provide the Name, Email and Company parameters in the URI query. Public share access will now require authentication for programmatic access for better security.

You can also download individual Items in the Share. Use the Share(id)/Items(id)/Download action. The item ID must be a top-level item in the Share - i.e., you cannot download or address files contained inside a shared folder.

Returns: Redirects the caller (302) to the download address for the share contents.

Download Items from a Share for a Recipient

GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias 
            GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias?id=itemid 
            GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias(itemid) 

Downloads items from the Share. The default action will download all Items in the Share. If a Share has a single item, the download attachment name will use the item name. Otherwise, the download will contain a ZIP archive containing all files and folders in the share, named Files.zip.

To download Shares that require user informaion ( Email, First Name, Last Name and Company), make sure to create an Recipient (alias)

To download Shares that require authentication, make sure this request is authenticated. Public share access will now require authentication for programmatic access for better security.

You can also download individual Items in the Share. Use the Shares(id)/Recipients(aliasid)/Download action. The item ID must be a top-level item in the Share - i.e., you cannot download or address files contained inside a shared folder.

Returns: Redirects the caller (302) to the download address for the share contents.

Download Multiple Items from a Share for a Recipient

POST https://account.sf-api.com/sf/v3/Shares(id)/Recipients(aliasid)/BulkDownload?redirect=true 
            ["id1","id2"] 

Download Multiple Items from a Share for a Recipient. The download will contain a ZIP archive containing all files and folders in the share, named Files.zip.

To download Shares that require user informaion ( Email, First Name, Last Name and Company), make sure to create an Recipient (alias) and pass in the alaisId.

To download Shares that require authentication, make sure this request is authenticated. Public share access will now require authentication for programmatic access for better security.

Returns: Redirects the caller (302) to the download address for the share contents.

Create Share

POST https://account.sf-api.com/sf/v3/Shares?notify=false 
            { 
              "ShareType":"Send", 
              "Title":"Sample Send Share", 
              "Items": [ { "Id":"itemid01" }, { "Id":"itemid02" } ], 
              "Recipients":[ { "User": { "Id":"userid" } }, { "User": { "Email": "user@email" } } ], 
              "ExpirationDate": "2013-07-23", 
              "RequireLogin": false, 
              "RequireUserInfo": false, 
              "MaxDownloads": -1, 
              "UsesStreamIDs": false 
            } 

POST https://account.sf-api.com/sf/v3/Shares?notify=false 
            { 
              "ShareType":"Request", 
              "Title":"Sample Request Share", 
              "Recipients":[ { "User": { "Id":"userid" } }, { "User": { "Email": "user@email" } } ], 
              "Parent": { "Id":"folderid" }, 
              "ExpirationDate": "2013-07-23", 
              "RequireLogin": false, 
              "RequireUserInfo": false, 
              "TrackUntilDate": "2013-07-23", 
              "SendFrequency": -1, 
              "SendInterval": -1 
            } 

Creates a new Send or Request Share. Expiration date: - if not specified the default is 30 days - "9999-12-31" disables share expiration.

To use stream IDs as item IDs UsesStreamIDs needs to be set to true, and all the IDs in Items need to be specified as stream IDs.

View Only: View Only share can be created by either setting "IsViewOnly = true" or "share.ShareAccessRight.ShareAccessRightType = ViewOnline" If both "share.IsViewOnly = true" and "share.ShareAccessRight.AccessRightType = FullControl" are passed to this method, then the "Full Control" permission takes higher priority and disables "ViewOnly" permission on the share.

Returns: The new Share

Update Share

PATCH https://account.sf-api.com/sf/v3/Shares(id)?appendItemsFeed=true 
            { 
              "Title": "New Title", 
              "ExpirationDate": "2013-07-23", 
              "RequireLogin": false, 
              "Items": [ { "Id":"itemid01" }, { "Id":"itemid02" } ], 
            } 

Modifies an existing Share. If Items are specified they are added to the share by default. If appendItemsFeed is set to false, the specified Items will replace any existing ones instead.

View Only: A share can be made ViewOnline/ViewOnly by passing either "IsViewOnly = true" or "Share.ShareAccessRight.AccessRightType = ViewOnline"

Returns: The modified Share

Delete Share

DELETE https://account.sf-api.com/sf/v3/Shares(id) 

Removes an existing Share

Create Share Alias

POST https://account.sf-api.com/sf/v3/Shares(id)/Alias?email=user@company.com¬ify=false 

Creates a share alias for the specified share ID and user email. If a user with the given email address does not exist it is created first. For shares requiring login an activation email is sent to the created user. If 'notify' is enabled, the user activation is included in the share notification email.

Returns: Share with the AliasID property set to the created alias ID

Deliver Send a File Email

POST https://account.sf-api.com/sf/v3/Shares/Send 
            { 
              "Items":["itemId1", "itemId2"], 
              "Emails":["email@sharefile.com", "email2@sharefile.com"], 
              "Subject": "Email Subject", 
              "Body": "Email Message", 
              "CcSender": false, 
              "NotifyOnDownload": true, 
              "RequireLogin": false, 
              "MaxDownloads": 30, 
              "ExpirationDays": -1 
            } 

Sends an Email to the specified list of addresses, containing a link to the specified Items. The default number of expiration days is 30. Setting it to -1 disables share expiration. Note that the Emails and Items parameters expect an array of strings, rather than nested JSON objects.

Returns: Share object

Deliver Request a File Email

POST https://account.sf-api.com/sf/v3/Shares/Request 
            { 
              "FolderId":"folderId", 
              "Emails":["email@sharefile.com", "email2@sharefile.com"], 
              "Subject": "Email Subject", 
              "Body": "Email Message", 
              "CcSender": false, 
              "NotifyOnUpload": true, 
              "RequireLogin": false, 
              "ExpirationDays": -1 
            } 

Sends an Email to the specified list of addresses, containing a link to upload to the specified folder. The default number of expiration days is 30. Setting it to -1 disables share expiration. Note that the Emails parameter expectd an array of strings, rather than nested JSON objects.

View Only: View Only share can be created by either setting "IsViewOnly = true" or "share.ShareAccessRight.ShareAccessRightType = ViewOnline" If both "share.IsViewOnly = true" and "share.ShareAccessRight.AccessRightType = FullControl" are passed to this method, then the "Full Control" permission takes higher priority and disables "ViewOnly" permission on the share.

Returns: Share Object

Re-deliver an Existing Share Link

POST https://account.sf-api.com/sf/v3/Shares/Resend 
            { 
              "Recipients":["email@sharefile.com", "groupId"], 
              "Subject": "Email Subject", 
              "Body": "Email Message", 
              "CcSender": false, 
              "NotifyOnUse": true, 
              "ShareId": "shareId" 
            } 

Resends an Email to the specified list of addresses, containing a link to a Send or Request Share

Returns: The updated Share

Upload File to Request Share

POST https://account.sf-api.com/sf/v3/Shares(id)/Upload?method=method&various... 
            POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 
            { 
                "Method":"Method", 
                "Raw": false, 
                "FileName":"FileName", 
                "FileLength": 123 
            } 

Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called.

Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume.

Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter.

Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec.

For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1".

For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0.

For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Returns: an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Get Redirection endpoint Information

GET https://account.sf-api.com/sf/v3/Shares(id)/Redirection 

Returns the redirection endpoint for this Share.

Returns: The Redirection endpoint Information

Get Inbox for Recipient

GET https://account.sf-api.com/sf/v3/Shares/Inbox 

GET https://account.sf-api.com/sf/v3/Shares/Inbox(id) 

Retrieve all outstanding Shares in the inbox.

Returns: List of Shares created by the authenticated user

Get Sent Message Content by Share

GET https://account.sf-api.com/sf/v3/Shares(shareId)/Recipients(aliasId)/Message?asJson=false 

Returns sent message content. By default the message is returned as a plain string. If asJson is true, the message string is wrapped in a Json object with a single "Message" property.

Returns: Sent Message Content