Integration requirements

Api access required

Heyday needs the following access:

  • API key

  • API password

  • Authentication access (very important)

  • Authentication access password

  • API endpoint → example: https://<DOMAIN_NAME>/rest/V1

If anonymous API access is not authorized, you must create a Heyday user on your magento. (By default, anonymous guest access is not allowed) Name: Heyday Email: it-magento@heyday.ai

Product search

For the product search feature, we need read access on:

  • Magento_Catalog::categories

  • Magento_Catalog::products

  • Magento_InventorySalesApi::stock if version >= 2.3

Shipment tracking

For the shipment tracking feature, we need read access on:

  • Magento_Sales::shipment

  • Magento_Sales::order

  • Magento_Sales::actions_view

IP Whitelisting

If your brand requires to whitelist the Heyday server, make sure to whitelist the following IP:

Production environments:

  • US:

    • 3.215.28.159: Prod IP on us-east-1, used by the bot in production on US account

  • Europe:

    • 35.156.106.148: Prod IP on eu-central-1, used by the bot in production on EU account

  • Canada:

    • 3.99.94.225: Prod IP on ca-central-1, used by the bot in production on CA account

Pre-production environment:

  • 18.159.72.173: Staging IP on staging account, ie. staging-eu (eu-central-1)

Dev environment:

  • 34.234.52.252: Dev IP on dev account, ie. dev-us (us-east-1)

Local dev/API validation:

  • 69.70.236.50: Open VPN / Office IP address, for local/Postman tests

  • 54.91.177.192: AWS VPN IP address, for local/Postman tests

PreviousMagentoNextPrestaShop

Last updated