Backend URL Configuration

The SDK provides flexibility in configuring the backend URLs used for API calls. By default, the SDK uses a predefined set of URLs, but you can customize this behavior to suit your application's needs.

Default URL Behavior

By default, the SDK follows these steps when deciding which URL to use:

1. If you add custom URLs using the ClientInfo#addUrls or ClientInfo#addUrl methods, the SDK will use those URLs first as these URLs have the highest priority.

2. If you do not provide any custom URLs, the SDK will use its built-in production URLs (the ones used in live environments).

• The specific built-in production URLs are not mentioned in the SDK documentation.

• The SDK only includes production URLs by default. If you want to use the SDK in a staging or development environment (for testing), you need to provide the stage URLs yourself using either the ClientInfo methods or by adding a file named pango_default_urls.json.

Customizing Backend URLs

You can override the default production URLs by adding a new raw resource file named pango_default_urls.json to your Android project.

The pango_default_urls.json file should follow this structure:

{
    "primary": [
        "https://url-1.net",
        "https://url-2.com",
        "https://url-3.com"
    ]
}

Specify your desired backend URLs in the "primary" array. The SDK will attempt these URLs in the order listed.

You can also provide an empty "primary" array to keep only the URLs specified via ClientInfo.

When to Use Custom Backend URLs

You may need custom backend URLs in these situations:

• You want to test the SDK with stage or development environments, not production.

• Your app has its own specific backend URLs.

• You want to use your own production URLs instead of the SDK’s default ones.

• You need to route API traffic through a proxy or firewall for security reasons.

• You are using different backend services (such as load balancing or region-based servers).

• Your app must follow compliance rules that require data to be routed through specific servers (e.g., for data residency requirements).

Additional Use Cases for Custom Backend URLs

Here are more situations where you might use custom backend URLs:

• Testing New Features: If you are developing new features or services, you might use a custom backend to isolate the testing environment from the production environment.

• A/B Testing or Experiments: You can use custom URLs to direct some users to a different server to test changes, while other users remain on the production server.

• Failover Support: You can configure custom URLs as a backup in case the primary server goes down, ensuring the SDK can still function by redirecting traffic to another URL.

• Geographical Routing: If you have users in different regions, you may want to direct their traffic to servers that are geographically closer to improve performance.