API Environments

Zitcha provides separate environments for testing and production across multiple regions.

Regional Availability

AU – Australia
EU – Europe
UK – United Kingdom
US – United States

Search API Endpoints

Endpoint Pattern: /search/v2/products/{organisationId} or /search/v2/banners/{organisationId}

Production

Region	Base URL
AU	`https://api.au.zitcha.app/search/v2`
EU	`https://api.eu.zitcha.app/search/v2`
UK	`https://api.uk.zitcha.app/search/v2`
US	`https://api.us.zitcha.app/search/v2`

Example: https://api.uk.zitcha.app/search/v2/products/{organisationId}

Sandbox

Region	Base URL
AU	`https://api.sandbox.au.zitcha.tech/search/v2`
UK	`https://api.sandbox.uk.zitcha.tech/search/v2`

Example: https://api.sandbox.uk.zitcha.tech/search/v2/products/{organisationId}

Collect API Endpoints

Endpoint Pattern: /v2/{endpoint} (e.g., /v2/product-update, /v2/ad-impressions)

Production

Region	Base URL Pattern
AU	`https://{organisation}.collect.au.zitcha.app`
EU	`https://{organisation}.collect.eu.zitcha.app`
UK	`https://{organisation}.collect.uk.zitcha.app`
US

Example: https://retailer1.collect.au.zitcha.app/v2/product-update

Sandbox

Region	Base URL Pattern
AU	`https://{organisation}.collect.sandbox.au.zitcha.tech`
EU	`https://{organisation}.collect.sandbox.eu.zitcha.tech`
UK	`https://{organisation}.collect.sandbox.uk.zitcha.tech`
US

Example: https://retailer1.collect.sandbox.au.zitcha.tech/v2/product-update

Note: Replace {organisation} with your organisation's subdomain.

Authentication

Search API

Authentication is optional for Search API v2. Most customers can use the API without authentication.

If your organisation has API authentication enabled, you must use OAuth 2.0.

Collect API

Authentication is required by default for Collect API v2. Some v2 endpoints can bypass authentication depending on your configuration.

OAuth 2.0 Configuration

If authentication is required, use OAuth 2.0 client credentials flow with the appropriate token endpoint and audience.

Production

Region	Token URL	Audience (Collect)	Audience (Search)
AU	`https://auth.au.zitcha.app/oauth/token`	`https://{organisation}.collect.au.zitcha.app`	`https://search.au.zitcha.app`
EU	`https://auth.eu.zitcha.app/oauth/token`	`https://{organisation}.collect.eu.zitcha.app`	`https://search.eu.zitcha.app`
UK	`https://auth.uk.zitcha.app/oauth/token`	`https://{organisation}.collect.uk.zitcha.app`	`https://search.uk.zitcha.app`
US	`https://auth.us.zitcha.app/oauth/token`	`https://{organisation}.collect.us.zitcha.app`	`https://search.us.zitcha.app`

Sandbox

Region	Token URL	Audience (Collect)	Audience (Search)
AU	`https://auth.sandbox.au.zitcha.tech/oauth/token`	`https://{organisation}.collect.sandbox.au.zitcha.tech`	`https://search.sandbox.au.zitcha.tech`
EU	`https://auth.sandbox.eu.zitcha.tech/oauth/token`	`https://{organisation}.collect.sandbox.eu.zitcha.tech`	N/A
UK	`https://auth.sandbox.uk.zitcha.tech/oauth/token`	`https://{organisation}.collect.sandbox.uk.zitcha.tech`	`https://search.sandbox.uk.zitcha.tech`
US	`https://auth.sandbox.us.zitcha.tech/oauth/token`

Example Token Request

curl --request POST \
  --url https://auth.au.zitcha.app/oauth/token \
  --header 'content-type: application/json' \
  --data '{
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "audience": "https://retailer1.collect.au.zitcha.app",
    "grant_type": "client_credentials"
  }'

Using the Access Token

Collect API v2 example:

curl --request POST \
  --url https://grocer.collect.au.zitcha.app/v2/product-update \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'content-type: application/json' \
  --data '{...}'

Search API v2 example:

curl --request POST \
  --url https://api.au.zitcha.app/search/v2/products/{organisationId} \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'content-type: application/json' \
  --data '{...}'