API Integration

The API integration lets you send buyer data for a product from Software Finder to your CRM (customer relationship management system) or internal systems. You create an API key in Buyer Intelligence, then use it to request buyers from the Software Finder API (application programming interface).

Some screens call buyers "leads". Both words mean the same thing.

note

• The selected product must be on a plan that includes Buyer Intelligence. See Buyer Intelligence.
• An API key works only for the product it was created for.

Open the Integration Page

1. In the left sidebar, click Buyer Intelligence.
2. Select a product from the product list at the top of the Buyer Intelligence menu.
3. Click Integrations. The Integration page opens.

Create an API Key

1. In API Key Management, click Generate API Key. The Generate API Key dialog opens.
2. In Expiration, select how long the key stays valid: Never, 1 hour, 1 day, 7 days, 30 days, 90 days, 180 days, or 1 year.
3. Click Create API Key. The Your API Key dialog shows the key and its expiry date.
4. Click Copy, and store the key somewhere secure.
5. Click Done.

The key is shown only once. Treat it like a password and do not share it publicly.

After you create a key, the API Key Management section shows a table with the masked key, its STATUS, its CREATED ON date, and its EXPIRES ON date.

Replace an API Key

If you lose your key or need a new one, click Regenerate API Key. This creates a new key.

Test the API

1. On the Integration page, click View API Documentation.
2. In the Authentication panel on the right, confirm the authentication scheme is crm-api-key.
3. Paste your key into the Value field for x-crm-api-key.
4. In the left menu, open Leads and select the endpoint.
5. Click Test Request.
6. Select a date range and enter any search or page values.
7. Click Send. The response appears in the Body panel.

Request Details

Item	Value
Method	GET
Endpoint	/api/v1/integrations/crm/leads
Server	https://api-vp.softwarefinder.com
Authentication header	x-crm-api-key: <your API key>

Query Parameters

Parameter	Required	Description
dateRange	No	Filters buyers by time. Values: last7days, last30days, last60days, last90days, alltime.
search	No	Searches by name, company, or email.
pageSize	No	Number of records per page.
page	No	The page of results to return.

Responses

Code	Meaning
200	The request succeeded. The response contains a paginated list of buyers for your product.
401	The x-crm-api-key header is missing, or the API key is invalid.
429	The rate limit was exceeded.

Rate Limits

Each product API key can make 60 requests per minute. Requests over the limit return 429 Too Many Requests.

FAQs

Why am I receiving a 401 response?

The key is missing, incorrect, or sent in the wrong header. Send it in the x-crm-api-key header, and use a key created for the same product.

Why am I receiving a 429 response?

The key exceeded 60 requests per minute. Wait before sending more requests.

I lost my API key. Can I view it again?

No. The key is shown only once. Click Regenerate API Key to create a new one.