Twitter Query Authentication Guide
This is a step-by-step guide to creating an OAuth entry, acquiring credentials, and authorizing the Twitter Query component for use in Matillion ETL.
- The Twitter Query component uses an OAuth for third-party authentication.
- While component properties may differ between Cloud Data Warehouses, the authentication process remains the same.
- Twitter accounts need to apply for authorization to develop apps. If the associated account has not yet been authorized, please be aware that the authorization process may take some time and is unfortunately outside of Matillion's control.
Creating an OAuth Entry in Matillion ETL
1. In Matillion ETL, on the top left of the screen, click Project, then click Manage OAuth.
If a Twitter Query component has already been added to an Orchestration Job, the Manage OAuth dialog may also be accessed using the following method:
- Click the component's icon to open the Properties panel at the bottom of the screen.
- Click next to the Authentication property, and click Manage in the pop-up dialog.
2. Copy the Callback URL in the field at the top of the window as this will be required in Acquiring Third-Party Credentials.
3. Click in the bottom left of the window to open the Add OAuth Entry dialog.
4. Provide a name for the OAuth in the Name field, then use the Service dropdown menu, and select Twitter. Click OK.
5. On returning to the Manage OAuth dialog, check the list of OAuth entries to ensure the new entry is listed.
This entry is Not Configured. Configuration of the OAuth entry will be discussed in Authorizing for use in Matillion ETL.
Acquiring Third-Party Credentials
1. Access the Twitter Developer portal, and click Log in.
2. When you log in successfully, the Overview page will be displayed. Scroll down to the bottom, and click + Create App.
- If this is the first time you are creating an app, the + Create App button will be situated at the top of the Overview page.
- There is a maximum quota of 10 apps that can exist at any time. You must delete an app to create a new one if 10 already exist.
3. The Name your App wizard will be displayed, where you will be required to enter your app details. Enter an appropriate name for your app in the App Name field. Click Next to continue.
4. Your app's API keys and token will be displayed. Copy the API Key and API Secret Key immediately as they will only appear once. You will need these strings later to Authorize for use in Matillion ETL. Click App Settings to continue.
When you copy the API Key and API Secret Key, some browsers may add a space to the end of each string. Watch out for this, as it will cause the credentials to fail.
You can regenerate your app's API Key and API Secret Key at a later date, if required.
5. Your app details will be displayed in the Settings dialog. To provide additional app details and security information, begin by clicking Edit next to App Details.
6. The Edit App details dialog will be displayed. You have the option to briefly describe the purpose of your app. Enter these details in the Description field provided. Click Save, and you will return to the previous page.
7. Click Edit, situated next to App permissions. Modify these settings, and click Save. You will return to the previous page.
Changing the permission settings might affect your app. You will be required to confirm the modification.
8. Click Edit, situated next to Authentication settings. To enable all the fields on this page, you will need to use the toggle switch to Enable 3-legged OAuth.
9. In the Callback URLs field, paste the Callback URL (copied from the Manage OAuth dialog in Matillion ETL earlier). Then, provide a Website URL in the field provided, to be associated with your app. Click Save. You will be redirected to the previous page.
You can add multiple URLs if you want to.
Authorising for Use in Matillion ETL
1. Return to the Manage OAuth dialog in Matillion ETL, and click next to the previously created OAuth entry. This will open the Configure OAuth dialog.
2. Using the strings copied from the Twitter Developer portal earlier, enter details in the following fields:
- Client ID: enter the API key.
- Client Secret enter the API Secret Key, then click Next.
3. The next dialog will have an Authorization link. Click on this link to authorize Matillion ETL to use the acquired credentials.
4. The browser will then redirect to a Twitter form requiring authorization to access the associated account. Click Authorize app to confirm.
5. The browser will return to Matillion ETL, stating "Authorization Successful".