How to enable folder sharing in Optimole

With the Folder Sharing feature, you can now create sub-API keys to grant access to specific folders in your Optimole account. This ensures that users only access the folders you allow without exposing all your assets.

Instead of sharing your global API key, you can generate a restricted sub-API key and share it with a user, controlling which folders they can access.

✨Benefits of Using Folder-Specific API Keys

✅ Restrict access to specific folders.

✅ Secure your account by avoiding sharing the main API key.

🚀 How to Set Up Folder Sharing with a Sub API Key

This process is divided into two steps:

Step 1: Create a New Sub API Key

1. Log in to your Optimole Dashboard.
2. Go to the API Keys section and click on Create a New Key.
   
   
3. Provide a name for the sub API key (e.g., "Limited Access for Client").
   
   
4. Once generated, you can copy and use the new sub-API key instead of your global API key when connecting the user to Optimole.
   

Step 2: Share your folders

1. Go to your Library and Select the folders that this API key should have access to.

2. Click on the "sharing" button.

   

3. Select your Sub-API key and save the settings.

   

Managing Sub-API key

If you ever wish to delete some of your sub-API keys, you can do it easily by following the steps:

1. Go to API Key Management in your Optimole Dashboard.
2. Find the sub-API key in the list.

3. Click on Delete to delete the Sub-API key immediately.

   

🛠 Common Use Cases

✅ Client-Specific Access

If you want a client to process images only from a specific folder (e.g., /clientA/ ), you can create a sub-API key that allows access only to /clientA/ .

✅ Multi-User Teams

For teams working on different projects, you can create separate sub API keys for each folder, ensuring controlled access.

📌 FAQs

Do sub-API keys have the same permissions as the main API key?

No, Sub-API keys have read-only access to shared folders.

Can I limit API key permissions beyond folder access?

No, currently, sub-API keys only restrict folder access but retain the same processing permissions as the global API key.

How many sub-API keys can I create?

There is no strict limit, but we recommend keeping it to essential users for better security management.

What happens if I delete a folder linked to a sub API key?

The API key will no longer have access to that folder.

📢 Need Help?

If you encounter any issues or have questions, check out our Optimole Documentation or contact our support team.