Social media API keys

Managed by | Updated .

Background

When creating a social media collection, the `custom_gather.groovy` script will require specific API keys in order to update the collection with the data from the social media. Depending on which template chosen when the collection was created, use the information below to obtain the correct keys.

Note that this information may get outdated as social media platforms evolve. Retrieving API keys for social media platforms is usually well documented on the social media platform developer website, so it may be useful to refer to it. It is also usually documented by third-parties in blog posts or tutorial that may be worth looking up.

Social media custom gather API keys

Facebook

The following keys are required and can be obtained from https://developers.facebook.com/apps/. The client will need to login to their Facebook account and create an app. They should go to the dashboard and provide:

  • App ID
  • App secret

To obtain these, login to https://developers.facebook.com/apps and create a new application.

  • Access token

A never expiring token will need to be retrieved. Follow: this article for details.

  • Page ID

This can be found in the page settings. Please see this article for details: https://www.facebook.com/help/community/question/?id=378910098941520. Alternativly use a tool such as https://findmyfbid.com/ to obtain the page ID from your page name.

Twitter

The following keys are required and can be obtained from https://apps.twitter.com/. The client will need to login to their Twitter account and create an App. They should go to key and access tokens and provide:

  1. OAUTH consumer key
  2. Consumer secret
  3. Access token
  4. Access token secret

    Visit https://dev.twitter.com/apps/new to create a new app and retrieve these values.

YouTube

The following keys are required and can be obtained from https://console.developers.google.com/project. The client will need to login in their google account associated with YouTube and go to credentials. They should create a new credential and provide:

  1. API key

    Visit https://developers.google.com/youtube/registering_an_application#Create_API_Keys to learn how to retrieve a YouTube API key.

  2. Channel ID

    Visit https://support.google.com/youtube/answer/3250431?hl=en to learn how to retrieve your channel identifier.

Instagram

  • Set up Instagram App

An 'App' must be created within the Facebook developer portal. The first three steps in the Get Started guide should be followed to set up your Instagram app (Create a Facebook App, Configure Instagram Basic Display, Add an Instagram Test User).

Note that Instagram may be added as a platform on an existing Facebook app if you already have one (it does not strictly need to be its own app). Rate limits are shared across apps when using a User Access Token.

  • User Access Token

Use the User Token Generator to generate a User Access Token.

  • App Review

Instagram requires apps to go through App Review before the apps can be promoted from development to production. The permissions required to submit for App Review are:

Was this artcle helpful?