Last Revised: 11 Sep 2020 Written by Veloxity CRM Time Estimate: About 1 minute to read. Version 2.0
Jump to the following sections to learn more about the Web Service API Key:
- What is a Web Service API Key?
- Where can I find the Web Service API Key?
- How can I Request a New Web Service API Key?
- Related articles
What is a Web Service API Key?
Veloxity offers a RESTful Web Service API to provide you with a way to develop integrations between your existing systems and Veloxity CRM.
How can I use the Web Service API Key?
The endpoints exposed through the API provide the capability to create, modify, and retrieve your data from Veloxity CRM.
To access the web service endpoints, you must generate an API Key.
Where can I find the Web Service API Key?
From the Main Menu click My Profile > App Setup > CRM Setup
The Web Service API Key is found in CRM Setup.
Navigating the Web Service API Key
You are looking at a screenshot of Requesting a New Web Service API Key:
Figure 1. Requesting a New API Key.
How can I Request a New Web Service API Key?
How can I generate a New API Key?
You need User and System Administration Privileges to request a Web Service API Key.
- Click Request New Web Service API Key to receive a new API Key.
- Your current API Key will no longer be valid.
- After clicking Request New Web Service API Key, the new API Key will be visible below the button.
What if I lose my API Key?
Be sure to copy the API Key. Keep the API Key in a safe place. Once you navigate away from this page, the Key will no longer be available. The Key cannot be retrieved from the system after it has been generated.
What happens to the logic used by prior API Keys?
Generating new API Keys will invalidate any prior API Keys that were created. Any logic using the prior API Key will need to be updated to use the newly created API Key.
Where can I find my Web Service API and documentation URL?
Click the Help Key for your Web Service API and documentation URL.