Skip to main content

Instagram

The @uppy/instagram plugin lets users import files from their Instagram account.

tip

Try out the live example or take it for a spin in CodeSandbox.

When should I use this?

When you want to let users import files from their Instagram account.

A Companion instance is required for the Instagram plugin to work. Companion handles authentication with Instagram, downloads the files, and uploads them to the destination. This saves the user bandwidth, especially helpful if they are on a mobile connection.

You can self-host Companion or get a hosted version with any Transloadit plan.

npm install @uppy/instagram

Use

Using Instagram requires setup in both Uppy and Companion.

Use in Uppy

import Uppy from '@uppy/core';
import Dashboard from '@uppy/dashboard';
import Instagram from '@uppy/instagram';

import '@uppy/core/dist/style.min.css';
import '@uppy/dashboard/dist/style.min.css';

new Uppy()
.use(Dashboard, { inline: true, target: '#dashboard' })
.use(Instagram, {
target: Dashboard,
companionUrl: 'https://your-companion.com',
});

Use in Companion

To sign up for API keys, go to the Instagram Platform from Meta.

Create a project for your app if you don’t have one yet.

  • Enable the Instagram API.
  • Use this for an authorized redirect URI: https://$YOUR\_COMPANION\_HOST\_NAME/instagram/redirect

Meta will give you an OAuth client ID and client secret.

Configure the Instagram key and secret in Companion. With the standalone Companion server, specify environment variables:

export COMPANION_INSTAGRAM_KEY="Instagram OAuth client ID"
export COMPANION_INSTAGRAM_SECRET="Instagram OAuth client secret"

When using the Companion Node.js API, configure these options:

companion.app({
providerOptions: {
drive: {
key: 'Instagram OAuth client ID',
secret: 'Instagram OAuth client secret',
},
},
});

API

Options

id

A unique identifier for this plugin (string, default: 'Instagram').

title

Title / name shown in the UI, such as Dashboard tabs (string, default: 'Instagram').

target

DOM element, CSS selector, or plugin to place the drag and drop area into (string or Element, default: null).

companionUrl

URL to a Companion instance (string, default: null).

companionHeaders

Custom headers that should be sent along to Companion on every request (Object, default: {}).

companionAllowedHosts

The valid and authorised URL(s) from which OAuth responses should be accepted (string or RegExp or Array, default: companionUrl).

This value can be a string, a RegExp pattern, or an Array of both. This is useful when you have your Companion running on several hosts. Otherwise, the default value should do fine.

companionCookiesRule

This option correlates to the RequestCredentials value (string, default: 'same-origin').

This tells the plugin whether to send cookies to Companion.

locale

export default {
strings: {
pluginNameInstagram: 'Instagram',
},
};