Authentication

Learn how to authenticate API requests securely

The API is available to Enterprise plan customers.

Overview

To authenticate your API requests, you need an API key. This key identifies and authorizes your requests, ensuring only authorized users can access resources.

Your API key provides access to all data available to your organization, including categories, regions, and category reports.

Getting Your API Key

1. Navigate to the API key generation portal

   1. Sign into the platform. Select your organization name at the top left of the screen, then select Settings.
   2. In the left sidebar under Account, select API Keys. This will show your key generation portal and a table of your keys.
2. Configure and create your key

   1. In the Create API Key banner, enter a key name and select the Expiration period.
   2. Select Create API Key to generate the key.

   For added security, you will not be able to retrieve your key again. Copy and store your API key securely before proceeding.

   Your API keys are displayed in a table on the API Keys page. Return to this page at any time to see your keys, check expiry dates, or revoke an existing key.

Authentication Methods

You can authenticate your requests using either method below:

Header Authentication (Recommended)

Include your API key in the X-API-Key header:

Header Method

POST /v1/reports/visibility HTTP/1.1
Host: api.tryprofound.com
X-API-Key: your_api_key_here
Content-Type: application/json

API Key Scope & Permissions

Your API key provides access to:

• Organization Data: All data belonging to your organization
• Categories: Available data categories and their metadata
• Regional Data: Location-based information and filters
• Reports: Generated reports and analytics for your categories
• Raw Data: Unprocessed data within your accessible categories

Security Best Practices

• Keep keys private: Your API key is sensitive information. Never share it publicly or commit it to version control. Store it securely and treat it like a password.
• Use environment variables: Store keys in environment variables or secure configuration files.
• Rotate regularly: Consider rotating your API keys periodically for enhanced security.
• Monitor usage: Check your API usage regularly to detect any unauthorized access.

Authentication Errors

Common authentication errors and their meanings:

Status Code	Error	Description
401 Unauthorized	Invalid API key	The provided API key is incorrect or expired
403 Forbidden	Insufficient permissions	Your API key doesn’t have access to the requested resource
429 Too Many Requests	Rate limit exceeded	You’ve exceeded your API key rate limit

Need Help?

If you encounter authentication issues or need to request API access, contact support for assistance.