An API lets you set up calls to make actions happen without a person needing to be directly involved in the process. The API, or application programming interface, allows software and other applications to interact and provide responses.
We’ve put together some use cases for the API based on common functions. Common use types include using the API for automation, user maintenance, and file or folder maintenance. API use in each of these categories can streamline your processes and help keep things up to date.
API and Automation
Automate routine file transfer activities like move, import, and copy.
Track & Move Incoming Files
Track incoming files via webhooks and use the API to move the received files into the processing system. For example, when artwork or photo files get uploaded for a customer order, have them automatically moved to the folder location necessary for them to be accessed and worked on by an employee.
Another example is a logistics company that works with purchase orders. The company receives a purchase order form from a vendor. Using the API, this order form then imports into the fulfillment system and is ready for the next stage in the process.
The API also allows you to distribute files to multiple locations in the system. If users have their own home folders assigned, and you have files that need to go to multiple users, you can automate the process. Upload files and use the API to create copies of those files in various locations.
Automatically assign files to sub-processors. When new files are uploaded, they can be assigned to specific users for processing. The API moves the uploaded files to the correct processing location.
Photo processing is one example. Customers submit photos, which get moved automatically to an available processor folder for editing. Similar use of an API is often seen with transcription services. Jobs are uploaded and assigned to a folder where someone will retrieve the files and complete the work.
User Maintenance with an API
If you have additional information you need to capture regarding new users, the API can help. One way is to create a web form for the user registration, then use the API to create the new user in your account. This comes in especially handy if you have special requirements for users, such as extremely complex passwords.
Another user maintenance example is to use the API to identify inactive users and delete or lock them from accessing your account. The API can verify your user list against account activity for a given period. The decision to delete or lock is then applied to any users that meet your inactivity criteria.
"username": "testuser", "nickname": "testnickname", "homeResource": "/", "email": "firstname.lastname@example.org", "password": "string", "role": "user", "expiration": "2011-03-21 00:18:56", "locked": true, "onboarding": true
Using the API for File & Folder Maintenance
Verify File Status
Without some type of program in place to check status, files can end up sitting for years, just taking up space. It’s a good practice to verify the status of stored files.
Reduce the need to manually review file status by having the API do the work. If you want files to automatically expire 90 days after upload, use the API to review the existing files in the system and identify files to delete based on your 90-day parameter. Then use the API to delete those files.
Create Folder Templates
Automatically create folder templates. If all new users get assigned to a folder with subfolders, the API can be used to create the sub-folders inside the new folder for that user. Commonly set up sub-folders include — incoming, outgoing, and logs.
It is vital to maintain valid information. The API can assist with this type of file maintenance. Check uploaded files for filetypes, file sizes, and report back to you if particular files are not as expected. This will alert you to missing data, incomplete file uploads, and other file issues before they heavily impact your business.
Incorporate the ExaVault API with one or more of your applications to automate and reduce manual actions. Control nearly all aspects of your file transfer account programmatically. Many clients use the API to write software to connect directly to their accounts.
In addition to the examples above, our API capabilities include:
- Uploading and downloading files.
- Getting information about activity occurring in your account.
- Creating and managing shares, including download-only shares and receive folders.
- Setting up and managing notifications.