Settings
This article covers handling your Uploadcare account, it explains how to create, manage, and configure “Projects.”
To access an account, sign up for Uploadcare and navigate to your dashboard.
Projects
The Uploadcare experience is centered around the concept of a project. Projects are separate environments that can hold different sets of files and settings. For instance, you could use one project to receive user-generated content, another for implementing advanced security features, and a third one to serve your frontend assets.
When you sign up for a new Uploadcare account, we add one default project. So, explicitly adding another project is optional: you can stick with the default one for creating a test environment and going through every other section of this article.
Project API keys
Uploadcare APIs and API clients (e.g., File Uploader) tell your projects from one another by their API keys.
We provide the two kinds of API keys: public and
secret. In this documentation, we refer to those as public_key
and secret_key, respectively.
Depending on which Uploadcare features you want to use, you will implement
either your public_key or a key pair.
Public API key
The main use of a public_key is to identify a target project for your uploads.
It is required when using Upload API or its clients such
as the File Uploader.
Secret API keys
A secret_key is required when using our REST API to
manage files within a project or implement
Video processing,
Document conversion or
Object Recognition,
or when using Secure Uploading. You can add
multiple secret API keys to a single Uploadcare project to ensure extended
control options over your environments.
Project files
The Files section allows viewing the set of files associated with the project. You can add new files, search the set for entries, copy individual file URLs or UUIDs, and delete files from a project.
While the Files view allows you to implement basic files management, use our REST API for more sophisticated scenarios like integrating Uploadcare with your product’s API.
Project teams
The account owner can add collaborators to their projects.
Collaborators:
- Have full access to project files.
- Have access to the settings of this project (including secret keys).
- Can't invite new users to the project.
- Can't delete the project. Only the project owner can do that.
- Don't have access to the payment settings for that project.
If the invited user doesn't have an Uploadcare account, they will be redirected to the sign up page (they should use the same email address to which they were invited). The invitation link is valid for 24 hours.
Project advanced settings
Under the Settings section, you can find more sophisticated options. Change those when setting up specific file flows; the deafults are perfectly fine for the majority of appliances.
Automatic file storing
When you Store files on Uploadcare, you make them permanent as opposed to temporary ones that are deleted from your account in 24 hours after the upload. By default, Uploadcare automatically stores every uploaded file. You can change the behavior by disallowing “Automatic file storing.”
Then, every file will be treated as temporary unless you explicitly Store a file by making a request to our REST API.
Secure uploading
You can further enhance the security of your file uploading by generating a special token on your backend and requiring our API to check token validity. This will allow you to implement access and control management in file uploading flows. This sections allows you to turn on the behavior. Note, when switched on, we will no longer accept any uploads to the project without a token. Please, refer to our Documentation to learn more.
Webhooks
Uploadcare REST API allows adding custom webhooks to notify your application about file uploads with the customized payload. Please, refer to API reference to learn more.
Custom amazon S3 bucket storage
You may choose to connect your storage to Uploadcare instead of using the one provided by Uploadcare (storage limits depend on your Pricing Plan). Please refer to the respective section of our Documentation for details. Note, that in such case Uploadcare's CDN features are available only via Proxy.
Configure backups
You can have all your Stored files to be copied to a custom S3 Bucket (or Selected Storage) automatically. Connect the storage once, and the system will do backups on a timely basis.
Custom OAuth applications
With File Uploader, users can upload files from various upload sources, such as Google Drive and Facebook. By default, Uploadcare requests access to these cloud services. This allows Uploadcare to see and download all files stored with this service.
With custom OAuth, you can set up your application icon, name, as well as Privacy Policy and Terms of Use.
Check out OAuth connection examples.
Whitelist
Protect your account from bad actors willing to do optimisations on your behalf, and get a proxy endpoint for Adaptive Delivery.
Edit project
This section allows changing the name of your project or removing it from your account. Click three dots next to the project's name in the list of projects to see the editing options.
Billing options
You can go to your Uploadcare Billing Options from your Dashboard or by using this link. From there, you can:
- See your current plan, limits status, and details about the charges for the next billing period.
- Configure your payment options: manage added cards and see payments history.
- Configure profile information.