Skip to main content

Farsight® API Authorization

Updated over 3 months ago

Farsight® lets you connect directly to its public API so that you can programmatically interact with it and your data. So long as you have a working Farsight® account and authorize your connection, you are then able to call all the API endpoints available to you.

Requirements

  • A working Farsight® account

  • API Key for authorization

Generate a Farsight® API Key

To be able to connect and use the Farsight® API, you must first authorize your connection and requests. For this purpose, you require an API key. You can generate an API key directly in your Farsight® account and since it will be tied to organization the Farsight® API will know it is indeed your key and as such will be able to serve you only your data.

Go to: Your account name > Settings > Business Account > API Keys

  1. Go to your account name

  2. Hover on Settings and click on Business Account

  3. Click on API Keys to go to your API Keys page

  4. Click on the + Create new secret key button to generate a new key. A pop-up window will appear where you will add a name to your new key. Once you click Done, a new pop-up window will appear from where you can copy your new API credentials (Client Id and Client Secret)

  5. To delete an existing key you can click on the trashcan icon next to it

Save Your New Key Credentials

Once your new Key is generated, a pop-up window will appear with your new Key credentials. For security purposes, this is the only time you will be able to see your credentials. Please make sure to save them in a secure place such as a password manager or keychain.

  1. Click on the copy-to-clipboard icon to copy your Client Id and save it on your preferred secure device for later use

  2. Click on the copy-to-clipboard icon to copy your Client Secret and save it on your preferred secure device for later use

  3. Once you saved your credentials securely, click on Done

Note: This pop-up window will only be shown to you once. You must save your Client Id and Client Secret locally to be able to use them. If you somehow lose them, you will have to delete the key and create a new one.

Authorize your API Connection

To make sure that only you can view your data and interact with Farsight® remotely you will be asked to Authorize your connection to the API using your Farsight® account API Key.

Go to: https://api.farsight.gg/swagger/index.html#/Auth/Auth_Index

Click on the Try it out! Button

  1. Paste your client id & client secret

  2. Click Execute. This will send an authorization request that will return a bearer token necessary to authorize your connection

Authorize the API Connection with the token

After you execute your command, you need to retrieve the access_token and use it to authorize your connection.

You can go to the 200 response message and copy the access_token value. You will then paste it in the Authorize value input as shown below.

  1. Click on the Authorize button at the top to open the pop-up window

  2. Input the access_token inside the Value input and click Authorize

A new pop-up window will appear showing that you are signed in to the API connection. You can remove the connection by clicking the Logout button at any time.

For security reasons, your connection will time out after 1 hour. When that happens, you will need to run the Auth API call to retrieve a new access_token and then use the new token to re-authorize your connection.

Did this answer your question?