API Keys

Feature snapshot

Summary:
API Keys are unique, alphanumeric strings that authenticate and authorize your applications when connecting with ActiveProspect services, ensuring secure access to data and functionality.

Key benefits:

• Secure authentication for API requests
• Simplified integration with ActiveProspect products
• Centralized management of access credentials across applications

Typical use cases:

• Integrating business applications with the ActiveProspect platform
• Automating lead management and data flows via API calls
• Enforcing secure data exchange between systems through controlled access

How the API Keys work

Step‑by‑step instructions

1. Log in to your ActiveProspect account by visiting account.activeprospect.com.
2. Navigate to the Settings section via the left navigation menu.
3. Click the Technical tab where your current API key is displayed.
4. To use your API key, highlight the key shown and copy it (using Ctrl+C on Windows or Command+C on macOS).
5. (Optional) If you suspect that your API key may have been compromised or if you need to rotate keys for security, locate and click the “Reset,” “Regenerate,” or similar option in the API Key section. Confirm the action when prompted.
6. Once reset, your account will display a new API key – copy this new key and update your application’s configuration accordingly.

Expected result:
Your ActiveProspect account will display your current API key under the Technical tab. If you initiate a reset, a new API key will be generated and displayed immediately after confirmation.

Validation & monitoring (optional)

• Test the setup: Send a test API request using your API key. A successful response (e.g., HTTP 200) indicates that the key is functioning correctly.
• Where to monitor?: Review API usage reports or transaction logs in your ActiveProspect dashboard to verify successful API calls.

Best practices

• Keep your API key confidential and share it only with trusted applications and team members.
• Regularly review API key usage to detect any unusual or unauthorized activity.
• Rotate (reset) your API key periodically or immediately if you suspect any compromise.
• Apply additional restrictions such as IP whitelisting, if available, to further secure your API usage.
• Immediately reset your API key if it might have been exposed or shared inadvertently.

Troubleshooting

Frequently Asked Questions (FAQ)

Q: What are API keys?
A: API keys are unique, alphanumeric credentials used to authenticate and authorize requests to ActiveProspect services, ensuring that only trusted applications can access and modify your data.

Q: Why are API keys important?
A: They secure your integrations by providing a mechanism for authentication and authorization, preventing unauthorized access and ensuring that all API requests are traceable to a validated source.

Q: How do I use API keys in my application?
A: First, log in to your account and retrieve your API key from the Technical tab under Settings. Then, include the API key in the header of your API requests to authenticate your connection with ActiveProspect services.

Q: Why would I reset my API keys?
A: Resetting may be necessary if you suspect compromise, need to enforce periodic key rotation as part of your security policy, or wish to revoke access for an application that no longer requires it.

Q: How do I reset my API keys?
A: Navigate to the Technical tab in your ActiveProspect account Settings, locate the API Key area, and click on the “Reset,” “Regenerate,” or similar option. Confirm the action to generate a new API key, then copy and update your configuration with the new key.

Glossary

• technical-settings.png200 KB