Integrating the Application
Seamlessly embed data retrieval capabilities into your existing applications and workflows using URL parameters.
The API that you see in the product page or that is generated as an example after data retrieval is for programmatic integration, perhaps for a batch process, as part of ETL/ELT processing, data pipelines, or automated integration into a product or another application.
However, using parameters within the URL of this application, you can have the data retrieved and the browser appearing wherever you might want to include it, such as a button in a CRM or Analytics application.
Available URL Parameters
Control application behavior by adding these optional parameters to the HTTPS URL
| Parameter | Description |
|---|---|
| apikey=[your-api-key] | Auto-populates the API license key field (only use with internal applications) |
| lookup=[data to lookup] | Auto-populates the lookup value field for data retrieval |
| action=go | Auto-clicks the data retrieval button for the pre-populated lookup field |
| showapi=false | Hides the example API call generated after the data retrieval |
Security Note: The apikey parameter should only be used with internal applications where the URL is not exposed to end users. Never include your API key in URLs that will be visible to external users or in public-facing applications.
Integration Examples
Example 1: Pre-populate Lookup Field
Example 2: Automatic Data Retrieval
Example 3: Complete Integration with Hidden API
Common Use Cases
CRM Integration
Add a custom button in your CRM that opens the application with customer data pre-populated for quick enrichment lookups.
Analytics Dashboards
Embed data retrieval links in your analytics dashboards to provide quick access to detailed information about specific data points.
Internal Tools
Integrate into internal admin panels or support tools to streamline data lookup workflows for your team members.
Data Management Systems
Create direct links from your data management interfaces to retrieve enriched information about specific records.
Tip: Combine multiple parameters to create a customized integration experience that fits your specific workflow requirements. All parameters can be used together or independently based on your needs.
Getting Started: Try opening the example URLs in your browser to see how the parameters work. Once you're familiar with the behavior, you can integrate these URLs into your applications, buttons, or workflows.
Need assistance with integration? Contact support@interzoid.com for help.