Account Setup

This step establishes environments, request routing, and credentials for APIs that require authentication. It should be completed before any data or recommendation requests are sent.

Preparation

  • Provide the list of brands or properties and the environments to create (development/test and production).

  • Identify technical owners for backend and frontend integration.

  • Confirm where credentials will be stored and which systems will use them.

  • Share any access restrictions (IP whitelisting, VPN, proxy, or domain verification).

  • Agree on who owns credential rotation and access management.

Main stakeholder

  • Customer integration developer / technical lead.

Results

  • Development and production environments created for each brand.

  • Base URLs and environment identifiers documented and shared.

  • OAuth credentials issued and verified with a test request.

  • Ownership defined for credential storage and rotation.

  • Analytics dashboard accounts created for each stakeholder for integration monitoring, quality metrics, and audience insights.

Set up environments and brands

Define the environments you will use (for example, production and test) and map them to brand names or properties. Each environment should have its own credentials and data scope so testing does not affect production.

Configure API access and credentials

Froomle APIs documented as authenticated use OAuth 2.0 Bearer tokens. We issue credentials per environment so protected requests are authenticated and routed correctly. Decide which services will hold the credentials and how you will rotate or revoke them when needed. See Authentication Guide. For step-by-step flow details, see Authentication flow.

Events API calls are unauthenticated. Do not send an OAuth Authorization header with event requests.

Confirm request routing

Confirm the base URL and the authentication requirements for each API. This ensures every request is routed to the correct environment without attaching credentials where they are not accepted. If you use a custom subdomain instead of the default Froomle hostname, follow Custom domain (CNAME).

Set up analytics access

We create dashboard accounts for the stakeholders who will monitor integration health, performance, and audience behavior.

Next step

Continue with item synchronization.