Your Uploadcare Account, Projects, and API Keys

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.

Uploadcare 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.

To discover API keys for an Uploadcare project, navigate to the respective section on the project overview page in your dashboard.

Depending on which Uploadcare features you want to use, you will implement either your public_key or a key pair.

Public API Keys

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. You can add multiple secret API keys to a single Uploadcare project to ensure extended control options over your environments.

Billing Options

You can go to your Uploadcare Billing Options from your Dashboard or by using this link. From there, you can:

Project settings

Project settings are located on the left sidebar of your project view. From there, you gain full control over individual project settings.

Start Guide

The Start Guide in your project view walks through the basic steps needed to upload a file to Uploadcare.

Project settings, Start Guide view
Project settings, Start Guide view

Usage Info

The Usage Info section provides information about your current limits in use. We also plan to add more detailed info on the rates of your limits consumption in Q3 2019.

Project settings, Usage Info view
Project settings, Usage Info view

Files in Your Project

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.

Project settings, Files view
Project settings, Files view

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.

Integration Guide

The Integration view outlines the possible next steps of handling files within your Uploadcare project. Specifically, we provide an extensive list of available Image Transformations.

Project settings, Integration Guide view
Project settings, Integration Guide view

API Keys

The API Keys view allows you to get the Public API Key for your project and to generate one more Secret API Keys. We thoroughly describe the further use of keys in the respective section of this article.

Project settings, API Keys view
Project settings, API Keys view

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.”

Project settings, Advanced, Automatic File Storing
Project settings, Advanced, 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.

Configure Backups

Uploadcare can copy every “stored” file to a custom S3 Bucket or Selectel Storage. The process is automatic, we require you to connect backup storage once, and will then systematically copy your files there to form a backup.

Project settings, Advanced, Configure Backups
Project settings, Advanced, Configure Backups

Custom OAuth Applications

This section allows setting up OAuth applications for one of the available providers. Please, refer to our Knowledge Base to learn more.

Project settings, Advanced, Custom OAuth Applications
Project settings, Advanced, Custom OAuth Applications

Configure Custom 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.

Project settings, Advanced, Configure Custom Storage
Project settings, Advanced, Configure Custom Storage

Webhooks

Uploadcare REST API allows adding custom webhooks to notify your application about file uploads with the customized payload. Please, refer to our Documentation to learn more.

Project settings, Advanced, Webhooks
Project settings, Advanced, Webhooks

Signed / Authenticated Uploads

You can further enhance the security of your file uploads 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.

Project settings, Advanced, Signed / Authenticated Uploads
Project settings, Advanced, Signed / Authenticated Uploads

Configure Project

This section allows changing the name of your project or removing it from your account.

Project settings, Advanced, Configure Project
Project settings, Advanced, Configure Project

We’re always happy to help with code, integration, and other stuff. Search our site for more info or post your question in our Community Area.