OAuth

Configuring auth is an important step and can be required in the following cases:

1. All App integrations that can access or add private data for users require authentication.

2. Any integration that stores private data will require authentication.

Before you start

• You should have a configured app.

• You should know which authentication schema to use based on your requirement.

• You should know the config details related to the authentication schema selected.

How it works

1. From your Partner Dashboard

2. Go to App. All your created apps will be visible on this page.

3. Select a created app.

4. You will be redirected to the App detail page.

5. Click on the Extension page.

6. Click the Authentication tab.

7. Then select the authentication scheme your app uses and enter the respective details:

   OAuth v2:

   1. (optionally) An Input Form to gather data from users, such as account team name or site URL for self-hosted apps

   2. An OAuth application configured in your own app’s settings, where you’ll add Eshopbox’s OAuth Redirect URL

   3. A Client ID (may be called Customer or API Key) and Client Secret (may be called Customer or API secret) from your app

   4. An Authorization URL on your app’s site where users will login with their account credentials NOTE: You can turn your form mode to code mode. Click the Switch to Code Mode to write a custom API call in JavaScript code.

   5. (optionally) A list of API scope(s) to restrict what Eshopbox can access

   6. An Access Token Request URL where Eshopbox exchanges the request token for an access token

   7. (optionally) A Refresh Token Request URL where Eshopbox can refresh the access token if it expires, along with an option to have Eshopbox automatically refresh credentials

   8. A Test API endpoint where Eshopbox can make an API call to ensure your user credentials work

   9. A Connection Label to uniquely identify users’ accounts.