API Configuration

This guide explains how to connect Vimeify to your Vimeo account using the Vimeo API.

Overview

Vimeify only requires a Vimeo Access Token to communicate with your Vimeo account. You have three options:

1. Use an existing Vimeo plugin connection (automatic, no setup needed)
2. Enter an Access Token via WordPress admin (easiest for most users)
3. Define Access Token in wp-config.php (recommended for developers)

Prerequisites

Before configuring the API connection, you need:

• Vimeo Account: Free or paid Vimeo account
• API Access Token: Personal access token from Vimeo (unless using existing plugin connection)
• Required Scopes: public, private, upload, edit, and delete

Option 1: Use Existing Vimeo Plugin Connection

If you already have another Vimeo plugin installed and configured (like the official Vimeo plugin), Vimeify can use that existing connection automatically.

No additional setup needed! Vimeify will detect and use the existing connection.

Automatic Detection

When you visit Vimeify → Settings → Connection, you'll see an option to "Use Vimeo plugin connection" if another Vimeo plugin is already configured.

Option 2: Create New Access Token

If you don't have an existing Vimeo connection, you'll need to create a new access token.

Step 1: Create a Vimeo App

1. Go to Vimeo Developer Portal
2. Click Create App (or use an existing app)
3. Fill in the application details:
   • App Name: Your WordPress site name (e.g., "My WordPress Site")
   • App Description: Brief description (e.g., "Vimeo integration for WordPress")
   • App URL: Your WordPress site URL (e.g., https://yoursite.com)
4. Click Create App

Step 2: Generate Your Access Token

1. On your app page, click the Authentication tab
2. Scroll to Generate an Access Token
3. Check the required scopes:
   • ✅ Public (View public videos)
   • ✅ Private (View private videos)
   • ✅ Upload (Upload videos)
   • ✅ Edit (Edit video metadata)
   • ✅ Delete (Delete videos)
4. Click Generate
5. Copy the generated token immediately (you won't be able to see it again)

Security Important

Keep your Access Token secure:

• Never share it publicly
• Never commit it to version control
• Store it securely using one of the methods below

Configuring the Access Token

Choose one of the following methods to configure your access token:

Method A: WordPress Admin (Recommended for Most Users)

This is the easiest method for most users:

1. Navigate to Vimeify → Settings → Connection
2. Select Long-lived Access Token
3. Enter your Vimeo Access Token
4. Click Connect
5. You'll see a success message if the connection is valid

Existing Connection

If you have another Vimeo plugin already configured, select "Use Vimeo plugin connection" instead.

Method B: wp-config.php (Recommended for Developers)

For better security and multi-environment support, define your access token in wp-config.php:

// Vimeo API Configuration
define('VIMEIFY_ACCESS_TOKEN', 'your_access_token_here');

Add this line before /* That's all, stop editing! */ in your wp-config.php file.

Benefits:

• ✅ Token is not stored in the database
• ✅ Easier to manage across environments (dev, staging, production)
• ✅ More secure than database storage
• ✅ Perfect for version-controlled deployments

Important

When the access token is defined in wp-config.php:

• You cannot disconnect via WordPress admin
• The connection form will be disabled
• To change or remove the token, you must edit wp-config.php directly

Method C: Environment Variables (Advanced)

For advanced setups using environment variables:

Step 1: Create a .env file:

# .env file
VIMEO_ACCESS_TOKEN=your_access_token_here

Step 2: Load it in wp-config.php:

define('VIMEIFY_ACCESS_TOKEN', getenv('VIMEO_ACCESS_TOKEN'));

TIP

This method is ideal for containerized environments (Docker) or deployment systems that use environment variables.

Verifying Your Connection

After configuring your access token, verify the connection:

1. Go to Vimeify → Dashboard
2. Check the Connection Status widget
3. You should see:
   • ✅ Connected status
   • Your Vimeo account name
   • Total videos count
   • API quota information

Connection Status Indicators

Connected (Authenticated)

• Green status indicator
• Shows your Vimeo username
• Displays account plan and quota
• Full access to all features

Connected (Unauthenticated)

• Yellow status indicator
• Limited API access
• Can view public videos only
• Cannot upload or manage videos

Not Connected

• Red status indicator
• No API access
• Check your token and try again

Troubleshooting Connection Issues

Invalid Credentials Error

Error: "Invalid API credentials"

Solutions:

1. Double-check your Access Token for typos
2. Ensure there are no extra spaces when copying the token
3. Verify the access token hasn't expired
4. Regenerate the access token if necessary
5. Check that you copied the entire token

Insufficient Permissions Error

Error: "Access token missing required scopes"

Solutions:

1. Go to your Vimeo app settings
2. Generate a new access token with all required scopes:
   • Public
   • Private
   • Upload
   • Edit
   • Delete
3. Update the token in WordPress

API Quota Exceeded

Error: "API rate limit exceeded"

Solutions:

1. Wait 1 hour for quota to reset (Vimeo quotas reset hourly)
2. Check your Vimeo plan's API limits:
   • Free: 1,000 calls/hour
   • Plus/Pro/Business: Higher limits
3. Consider upgrading your Vimeo plan for higher limits

Connection Timeout

Error: "Connection timed out"

Solutions:

1. Check your server's firewall settings
2. Ensure outbound HTTPS connections are allowed
3. Verify your hosting provider doesn't block Vimeo API (api.vimeo.com)
4. Contact your hosting provider if issues persist

SSL Certificate Error

Error: "SSL certificate problem"

Solutions:

1. Ensure your server has up-to-date SSL certificates
2. Contact your hosting provider to update CA certificates
3. Verify PHP cURL is properly configured
4. Check PHP version is up to date

Next Steps

Now that you've configured the API connection:

• Initial Setup - Configure plugin settings
• Video Upload - Start uploading videos
• Auto Sync - Set up automatic synchronization
• Galleries - Create video galleries

Getting Help

If you encounter connection issues:

• Check the FAQ for common questions
• Visit the Troubleshooting guide
• Join our Support Forum
• Contact Premium Support (Pro users)