If you are new to the Intralinks platform - Welcome! If not, then, welcome back! Regardless of where you came from or how long you have been working with our API there are a number of new things to look out for. If you are a veteran user, you are probably familiar with how APIKeys work and logging in recently though we have changed things up a bit. We still use a set of keys, but they are different than the APIKey/client id of the V1 API. The latest iteration of the Intralinks API uses OAuth2 to authenticate and that means using a consumer key and consumer secret in the OAuth2 calls.
Don’t worry, if you are still using the V1 session APIs with an APIKey, your calls will continue to work. Those APIs are not going anywhere. However, to take advantage of all the new APIs going forward you will have to migrate your code to use the new OAuth login method.
To get going, there are a few tasks to be done.
Step 1 - Register on the portal
First things first. You will need to register on the portal to get a developer account. This will get you access to a few additional areas on the site like the Forums and the “My Apps” section. Once you are logged in, head over to the My apps section to complete the next step.
Step 2 - Create an app
Once you are registered, creating an app is the next step in the process. Each app is issued a set of keys and is what identifies your application to the Intralinks service. These keys don’t actually give you access to any documents or workspaces, but simply tells our platform that you are authorized to make API calls. When you first create your app you need to specify just a few pieces of information.
- Name - The app name is a way to tell your apps apart. You can have more than one app so make this name descriptive of it’s intended purpose.
- OAuth Callback - Second you must specify a callback URL for the OAuth2 flows. Our API does not support open redirects so when your app calls the /authorize API we will redirect the user to the URL specified here. If you have more than one possible URL, like one for your test environment and one for production, you can create multiple apps to specify individual URLs.
If you are not sure what the URL should be drop us an email and we can walk you through all the options.
Step 3 - Intralinks approves your app
When you first create your app, it will be in the ‘PENDING” state.
There are a few things we do on our side to get you up and running like creating a test exchange and credentials. After which we will move your application into the "Approved" state which makes your keys live. That brings finally us to step 4...
Step 4 - Access to a test workspace.
API keys themselves don’t actually give you access to anything (documents/workspaces/etc) all it does is give your application the authority to make API calls. You (and any future users of your application) will still need a username and password to authenticate to the platform and get access to things stored there. In the TEST environment we will provision you an account so that you have something to work with while you develop. Once you are ready to move to production your users can use their normal username/passwords with your API program.
Once you have your API key and username/password you everything you need to get started. If you are ready to jump right in with our tutorial for downloading a document which provides some example cURL commands to do the basics like log in, enter a workspace, and get a list of documents. Or open up the Interactive V2 API page to use your new key and try the commands yourself!
Don’t forget, if you get stuck, drop us an email. We are here to help!