Overview

This documentation guides you through HawkSearch's environments and endpoint architecture. You'll learn:

1. Available HawkSearch environments and their purposes
2. How to get support for customer-specific endpoints configuration
3. How customer-specific endpoints work and their structure
4. The benefits of using customer-specific endpoints

Getting Started

To start using your customer-specific endpoints, please contact our CSD team, they will:

1. Set up your customer-specific endpoints across all environments
2. Provide guidance on implementation
3. Ensure smooth configuration of the new endpoints

Environments Overview

HawkSearch Provides 3 distinct environments to support your development lifecycle:

1. Development: For initial development and testing of new features
2. Test: For quality assurance and user acceptance testing
3. Production: For live, customer-facing implementations

Customer-Specific Endpoints (Vanity URLs)

What is customer-specific endpoints?

Customer-specific endpoints are customized and branded web address designed specifically for your organization. Each HawkSearch client will receive a unique endpoint URL based on their engine name. The format for your endpoint URL is ..-.hawksearch.com.

Here's a breakdown of the components:

1. <engine name>: This is your unique engine name. To find your engine name, please go to Admin > Account Info > Setup Info > Engine Name.

   

2. <env>: This represents the environment. Development environments have dev, and Test environments have test. Production environments do not have any suffix, and would omit this value.

3. <component>: This specifies the component you are accessing, such as search, index, tracking, dashboard, etc. Components and their corresponding value are listed in the table within the API in Each Environment section.

4. <region>: This indicates the region. The following table shows the regions and their corresponding region code.

   Region	Region Code
   North America	na
   Asia	asia

Benefits of Customer-Specific Endpoints

1. Dedicated infrastructure: each customer-specific endpoints operates on dedicated resources, ensuring consistent performance.
2. Enhanced Security: provide isolated environments, ensuring secure and protected access to your search services.
3. Streamlined management: clear environment separation allows for easier deployment workflows and streamlined maintenance procedures.
4. Advanced monitoring: individual endpoint tracking enables precise monitoring of performance metrics and usage patterns specific to your implementation.
5. Operational stability: dedicated resources allocation ensures consistent performance and responsiveness through exclusive infrastructure utilization.

API in Each Environment

Development

Configurations for an engine in this location are maintained in the HawkSearch Workbench at <https://dev.hawksearch.net>.

Test

Configurations for an engine in this location are maintained in the Hawksearch Workbench at https://test.hawksearch.net.

Production

Configurations for an engine in this location are maintained in the HawkSearch Workbench at <https://dashboard-na.hawksearch.com/>