Guides
My Account

Simulate App Connect in sandbox

This feature is available under the Sandbox credentials section in the Solution Provider Center. It allows you to preview the authorization experience and test your integration before publishing your app.

Overview

Use the Simulate App Connect feature to:

  • Review the authorization flow using the Demo Connect App.
  • Test your app's OAuth 2.0 integration.

Review the connection flow (Demo Connect App)

Use the Demo Connect App to understand the end-to-end authorization experience of a seller, when an app is authorized from the App Store.

How to use it

Locate the Demo Connect App under Sandbox credentials > Simulate app connect in Sandbox, and click Connect.

What to expect

A simulated OAuth 2.0 connection flow is initiated, walking you through the authorization screens and consent steps. It gives you a preview of the seller experience and how they navigate to grant access to your application. Reviewing this flow helps you design onboarding instructions and support documentation.

Login credentials

As this is a demo or test experience, you can use any credentials to simulate the connect flow.

Test your app's connection flow

Once your app is configured, you can simulate a real connection flow to validate your OAuth 2.0 implementation and simulate how a seller will connect directly to your app.

Prerequisites

Before your app appears in the simulation list, register the required callback URL and login URL in your app’s configuration settings.

How to test

Once your URLs are saved, your app appears in the simulation list. Click Connect on the app tile to initiate the flow.

Sandbox tokens

Upon completion of the simulated OAuth 2.0 workflow, authorization tokens are generated.

These tokens are valid for the sandbox environment only. Use them to validate the API calls and verify integration behavior before moving to production.

Complete the OAuth 2.0 flow

After completing the connection flow, you will see an Authorization successful screen with an authorization code (valid for 15 minutes) and Seller ID.

Use this code to generate access tokens and complete the OAuth 2.0 flow. The following steps are required:

Step 1: Exchange authorization code for tokens

Send a request to exchange your Authorization code for a refresh token and initial access token. The response will also include the expiration details for both tokens. Refer to Token API and Get an access token using Token API.

Step 2: Generate a new access token

Since Access Tokens are short-lived, use refresh token to generate a new access token when needed. This allows your app to maintain a connection without requiring the user to log in again. Refer to Token API and Refresh the access token.

Step 3: Make a simple API call

Verify your integration by making a test call to a Marketplace API, for example the Get All Items API. Include the access token in the request header to authenticate the request.

Additional resources

Updated 9 days ago