Upsales uses REST API, which means that you can create, fetch or update anything in your Upsales account via an integrated or custom application using an API key that you generate in Upsales.
The API key has unlimited access to modify your Upsales account. Therefore, it is important to restrict who has access to the API key and what actions they can perform with it.
You must have Administrator access to generate an API Key.
We recommend that you create a separate API key for each integration. This way, you can track what actions each API performs in your account if you need to troubleshoot any integration issues.
To generate an API key, complete the following steps.
-
Select the Settings icon in the upper right corner of your Upsales screen.
-
Select Settings.
-
From the left-hand menu, select Security from the Account section. Select API-keys.
The API-keys screen shows any API keys you have previously created.
-
Select New API-key.
-
In the Create API-key screen, enter a Name to help you identify this API key.
-
Select Generate key.
The unique API key is displayed. Note that this is the only time this key will be displayed. You cannot retrieve it again later from this page.
-
Select Klick to copy to copy the API key to your computer's clipboard.
-
Paste the API key in another location for storage. Make sure to save it in a safe location, as it can be used to modify your account.
-
Select Close to close the Create API-key screen.
Replace an API Key
You cannot make changes to an existing API key. However, you can replace an API key.
To replace an API key, complete the following steps.
-
Select the trash can icon next to the API key to remove it from your account. That API integration will no longer work.
-
Create a new API key and use the new API key code in all of the places where the previous version was used.
Work with an API Key
For additional documentation on programming API key usage, refer to the Upsales API documentation.
Comments
0 comments
Please sign in to leave a comment.