ShareFile API
  • Not Currently Logged In |
    Log In
  • ||
    Logout
  • arrow Getting Started
    • Quick Start Guide
    • OData Implementation
    • FAQ
    • Authentication
    • Postman
    • Storage Zones
  • Get an API Key
  • arrow API Entities
    • AccessControls
    • Accounts
    • Apps
    • AsyncOperations
    • Capabilities
    • ConnectorGroups
    • Devices
    • EncryptedEmails
    • FavoriteFolders
    • Favorites
    • FolderTemplates
    • Groups
    • Items
    • Metadata
    • Policies
    • Reports
    • Sessions
    • Shares
    • StorageCenters
    • Users
    • WebhookClients
    • WebhookSubscriptions
    • Workflows
    • Zones
  • arrowWebhooks
    • Overview
    • Events
    • Payloads
    • Signature Keys
  • arrowHow-To Guides
    • Common Use Cases
    • Troubleshooting
  • arrowCode Samples
    • C#(.NET)
    • Command Line / CURL
    • PHP
    • Python
    • Ruby
    • VB(.NET)
  • arrowSDKs
    • PowerShell
    • .NET
    • JavaScript
  • Terms of Use

Common Use Cases

This page illustrates how to achieve common ShareFile use cases by leveraging the API. This guide assumes you are already familiar with the basics of ShareFile and the API.

These examples are written in JavaScript-like pseudocode, so they are not meant to be executed as working code. To learn how you may write a concrete implemenation of these use cases in your preferred programming language, please consult our Code Samples and SDKs.

MakeRequest

The MakeRequest method is the foundation of these examples, as it represents the interactions our code makes with ShareFile. Here is a high level algorithm of what MakeRequest does:

Upload File and Create Share Link for it

Create a Public Upload Link to a new Folder

Create a new Client User and share a new Folder with it

Create a Share Link to a file, and add a new Recipient to it