Environments

Overview

The Rokt Catalog API operates in a single environment: Production. For partners integrating with Catalog, both initial setup and testing are performed within the Production environment. To safely test your integration without affecting your live data or operations, you use designated test brand accounts provided by Catalog. This allows you to develop and test using real API endpoints and functionality while ensuring your testing activities do not impact live brands or orders.

To keep your test activities separate from your main account, we recommend using a separate login for testing purposes (e.g., partner+dev@example.com).

Using the Production Environment for Testing

• API Endpoint: All API calls are made to the Production endpoint: https://api.shopcanal.com.
• Test Brands: During testing, you are connected only to Catalog's designated test brands.
• Test Orders: Any orders placed with test brands are for testing purposes only and do not result in actual transactions or fulfillments.
• Test Payment Methods: Use test payment methods as directed by Catalog to prevent real monetary transactions during testing.

Getting Started with Testing

1. Create a Test Partner Account: Sign up for a separate partner account using a unique email address (e.g., partner+dev@example.com). This account is used solely for development and testing purposes.

2. Obtain Your API Token: In your test partner account, navigate to Settings under API Credentials to find your API Token.

3. Access Test Products: After logging into your test partner account, you have access to pre-approved test products from Catalog's designated test brands. These products can be used to test your API implementation. If you don't see them in your test account, ask your Rokt Catalog rep to add them for you.

4. Begin Integration: Use the API Token from your test partner account to authenticate your API calls. All API requests should be directed to the Production endpoint: https://api.shopcanal.com.

attention

• Keep test and live data separate: Use the test partner account for all development and testing activities to prevent unintended interactions with your live account.
• Avoid real transactions: During testing, use only the test brands and test payment methods provided. Do not place real orders or conduct live transactions.

Moving to Live Operations

Once you have completed your integration and testing, and are ready to go live:

1. Switch to Your Live Partner Account: Begin using your main partner account for all live operations.

2. Update API Credentials: Obtain the API Token from your live partner account's Settings under API Credentials. Replace any test credentials in your integration with your live credentials.

3. Connect with Live Brands: Start connecting with real brands and products for your marketplace.

4. Perform Final Checks: Ensure that all aspects of your integration are functioning correctly in the live environment, including product listings, ordering, payment processing, and fulfillment.

Questions and Support

If you have any questions or need assistance during setup or testing, please reach out to the Rokt Catalog support team.