Skip to main content

FHR - How to: Migrate to customer-specific URLs

Documentation Team
  • Updated

    Introduction

    As a Fredhopper client, you use one or more customer-specific API endpoints and URLs to reach the (online) tools (Preview pages and Merchandising Studio).

    In the past, you could reach these endpoints and tools using shared URLs, e.g. "https://query.published.live1.fas.eu1.fredhopperservices.com/fredhopper/query".

    Warning: Shared URLs used to access API endpoints and (online) tools will be deprecated and discontinued in October 2026.

    Your customer-specific URLs are created during onboarding and include your unique cloud account/tenant name. However, within the URLs, underscores must be replaced with hyphens:

    • Cloud account/username: your_account_name
    • within the URL: your-account-name

    Benefits of migrating

    Migrating from shared URLs to customer-specific URLs offers you various benefits:

    • Faster response time due to optimized authentication and request processing
    • Advanced capabilities through access to features like A/B testing, Single Sign-On (SSO), Keep-Alive connection, and global API serving
    • Enhanced Monitoring capabilities, including but not limited to, improved monitoring of 5** error rate changes codes which allow Crownpeak to proactively correct these before performance is degraded.

    Customer-specific URLs

    All customer-specific URLs must include your cloud account/tenant name and specify one of the following environments:

    • live1
    • test1
    • test2
    • test3
    • test4

    Note: The environments available to you depend on your contractual agreement.

    The following lists provide examples for all available endpoints. We will use your-account-name, service, and env1 as a placeholder for your account name, specified service, and environment respectively.

    Query API

    URLDestinationPurpose
    https://your-account-name-query-env1.fas.global.fredhopperservices.com
    /fredhopper/query    		Query API published endpoint for your fas:env1

    Handling search, lister, and product detail requests sent by front-end

    Test environments: For development and testing only.

    https://your-account-name-query-env1.suggest.global.fredhopperservices.com
    /json    		Query API endpoint for your suggest:env1

    Handling of requests for search suggestions sent by front-end

    Test environments: For staging, development, and testing only.

    Data API 

    Warning: The name data end-point are not yet active. Please do not use these for the time being. We will confirm once this is ready to be used.

    URLDestinationPurpose
    https://your-account-name.data.global.fredhopperservices.com
    /service:env1/data    		Data API endpoint for your service:env1 (e.g. fas:live1)Accepting input data and downloading data
    https://your-account-name.data.global.fredhopperservices.com
    /service:env1/trigger    		Data API endpoint for your service:env1 (e.g. suggest:test2)Accepting triggers for data processing and providing trigger status
    https://your-account-name.data.global.fredhopperservices.com
    /service:env1/stream    		Data API endpoint for your service:env1 (e.g. upload:test1)Accepting and processing streaming data in real time for continuous ingestion

    Online tools (GUI) 

    URLDestinationPurpose
    https://your-account-name-config-env1.fas.global.fredhopperservices.com
    /fredhopper/query    		Query API pre-published endpoint for your fas:env1

    Handling search, lister, and product detail requests sent by staging front-end

    Live environment: Not suitable for handling front-end traffic.

    Test environments: For staging, development, and testing only.

    https://your-account-name-config-env1.fas.global.fredhopperservices.com
    /preview    		Preview pages for Query API pre-published endpoint for your fas:env1

    Reviewing pre-published state of configuration via built-in front-end by humans

    All environments: Not suitable for real front-end integration.

    https://your-account-name-query-env1.fas.global.fredhopperservices.com
    /preview    		Preview pages for Query API published endpoint for your fas:env1

    Reviewing published state of the configuration via built-on front-end by humans

    All environments: Not suitable for real front-end integration.

    https://my.short-region.fredhopperservices.com
    /your_account_name/

    *Note that this URL has not changed and uses the "old" account name formatting using underlines.

    		Preview pages for your Data API; your customer-dashboard 

    Reviewing of input, output, and trigger information by humans

    All environments: Not suitable for real back-end integration.

    https://your-account-name-config-env1.fas.global.fredhopperservices.com
    /fredhopper/admin    		Merchandising Studio for your fas:env1Managing business rules and other configurations
    https://your-account-name-config-env1.cru.global.fredhopperservices.com
    /config/running/ab-tests    		Configuration API endpoint for your cru:env1Handling of configuration of A/B testing requests sent by front-end
    https://your-account-name-report.insights.global.fredhopperservices.com/Insights dashboardViewing data

    Comparison: Old vs. new URL template

    OldNew
    https://query.published.env1.fas.eu1.
    fredhopperservices.com/fredhopper/query

    https://your-account-name-query-env1.fas.global.fredhopperservices.com
    /fredhopper/query

    https://query.published.env1.suggest.eu1.
    fredhopperservices.com/your_account_name/json    		https://your-account-name-query-env1.suggest.global.fredhopperservices.com
    /json
    https://my.eu1.fredhopperservices.com
    /fas:env1/data    		https://your-account-name.data.global.fredhopperservices.com
    /fas:env1/data

    Related articles

    Comments

    0 comments

    Article is closed for comments.