Platform credentials

Platform credentials

Some ecommerce platforms require every third-party integration to use its own registered app credentials — they do not allow shared or default keys. If your integration with one of these platforms is not working or cannot be activated, you likely need to add your credentials first.

This is not a limitation of EcartAPI. It is a requirement imposed by each platform for reasons such as rate-limit isolation, marketplace compliance, or security policy.

Platforms that always require your own credentials

The following platforms will not work with shared credentials. You must register your own app in each platform's developer portal and enter the credentials in your EcartAPI dashboard before your customers can connect their stores:

PlatformRequired credentials
ShopifyAPI Key, API Secret
WixApp ID, App Secret
TikTokApp ID, App Key, App Secret
TrayApp Key, App Secret
AliExpressApp Key, App Secret
TemuApp Key, App Secret

This list may grow as platforms update their API policies. If your platform is not listed here but your integration is failing with a credentials error, check your dashboard's E-commerce Setup for that platform.

Platforms with optional custom credentials

For any platform that supports OAuth 2.0, you can optionally use your own developer credentials instead of EcartAPI's defaults. This gives you full control over rate limits, branding in the OAuth consent screen, and API quota. When your own credentials are entered, EcartAPI uses them for all requests on that platform.

Platforms with additional requirements

Some platforms go beyond a key and secret. Below are known cases where extra values are needed:

Allegro — App name and App website

Allegro requires all API requests to include a custom User-Agent that identifies the app making the request. EcartAPI generates this User-Agent automatically, but it needs two values from you:

FieldDescription
App nameThe name of your application as registered in the Allegro Developer Portal.
App websiteThe URL of your app's homepage, project website, or GitHub repository.

Without these values, Allegro will reject requests with an error.

Etsy — Application Secret (when using your own keys)

If you use EcartAPI's default Etsy credentials, no extra setup is needed. However, if you choose to use your own Etsy app credentials, Etsy also requires the Application Secret (called "Shared Secret" in the Etsy developer portal) to validate requests. You must provide it alongside your Key String.

FieldDescription
Key StringYour Etsy app's API key.
Application SecretThe Shared Secret from your Etsy app settings. Required when using your own credentials.

How to add your credentials

All credentials are entered in the E-commerce Setup section of your EcartAPI dashboard:

  1. Go to your app in the EcartAPI dashboard.
  2. Open E-commerce Setup.
  3. Select the platform you want to configure.
  4. Enter the required values for that platform.
  5. Save. EcartAPI will use these credentials for all integrations under your app on that platform.

How to get your credentials

Each platform has its own developer portal where you register an app and obtain credentials:

When registering your app in the platform's portal, you will typically be asked for a redirect URL or callback URL. Use the OAuth redirect URL provided by EcartAPI for your app (found in your dashboard).

Next

→ Store authentication — How customers connect their stores and what you receive in the redirect.
→ OAuth 2.0 — How the OAuth flow works and how to send your customers to it.


Did this page help you?