Set up an OAuth 2.0 HTTP connection to eBay

Tom Santiago

Updated November 18, 2024 20:33

eBay documentation: API guide , Authentication

A. Set up an HTTP connection

Important

Verify that you are signed in to eBay as the account owner when setting up a connection.

Start establishing an HTTP connection to ebay in either of the following ways:

From the Resources menu, select Connections. Then, click + Create connection at the top right.

– or –
While working in a new or existing integration, you can add an application to a flow simply by clicking Add source or Add destination/lookup.

In the resulting Application list, select HTTP.

The Create connection pane opens with required and advanced settings.

Name (required): Provide a clear and distinguishable name. Throughout integrator.io imports and exports, you will have the option to choose this new connection, and a unique identifier will prove helpful later when selecting among a list of connections that you’ve created.

Application (required, non-editable): A reminder of the app you’re editing.

Mode (required): Select one of the following options:

Cloud to connect to a publicly accessible server application
On-premise to connect to a server that is publicly inaccessible and has integrator.io agent installed on it

B. Edit HTTP application details

Note

This article is concerned only with the settings needed for eBay connections. For complete field documentation, see Set up an OAuth 2.0 HTTP connection.

Configure HTTP headers: Leave the Name and Value fields blank.

Base URI: Enter the following value: https://apiz.ebay.com

Media type: Select JSON from the drop-down menu.

Success media type: Select JSON from the drop-down menu.

Error media type: Select JSON from the drop-down menu.

C. Configure auth settings

Enter the following values in the Configure auth section of the Create connection pane. Leave all fields not explicitly described in this section at their blank or default values.

Authentication type: Select OAuth 2.0 from the drop-down menu. The menu items switch to Oauth 2.0 authentication fields.

Grant type: Select Authorization code from the drop-down menu.

Callback URL: This field automatically defaults to https://integrator.io/connection/oauth2callback.

Note

The callback URL must be added to the eBay developer account while configuring the HTTP connection. Use the following steps to set the redirect URI for the eBay developer account:

Log in to your eBay developer account.
From Home, navigate to Application Keys>User Token.
Select the eBay account for your environment (production or sandbox).
Click Get a Token from eBay via your Application.
Click + Add eBay Reditrect URL.

Enter the following values:
- Display Title: Integrator IO
- Your privacy policy URL: https://integrator.io/connection/oauth2callback
- Your auth accepted URL: https://integrator.io/connection/oauth2callback
- Your auth declined URL: https://integrator.io/connection/oauth2callback
Click Save.

iClient: Assuming you haven’t yet established an eBay iClient (token ID-secret pair), click the + button to create one . Enter an identifiable Name along with the Client ID and Client secret from your eBay account. Click Save & close to add the iClient to your integrator.io account and select it for this connection.

Authentication URL: Enter the following URL: https://auth.ebay.com/oauth2/authorize

Scopes: Enter the following value: https://api.ebay.com/oauth/api_scope/sell.finances

Access token URL (required): Enter the following value: https://api.ebay.com/identity/v1/oauth2/token

Client authentication: Use the drop-down menu to select Send as basic auth header.

Location (required): Select Header from the drop-down menu.

Header name: Verify this field has the word "Authorization" entered.

Scheme (required): Select Bearer from the drop-down menu.

D. Specify How to test this connection?

Expand the How to test this connection? section.

Ping relative URI: Enter the following relative URI: /sell/finances/v1/transaction

Ping method: Select GET from the drop-down menu.

E. Edit advanced eBay settings

Before continuing, you have the opportunity to provide additional configuration information, if needed, for the eBay connection.

NOTE: Selecting another app changes form...

Save & authorize – click to save the connection and exit the Create connection pane.

Cancel – click to exit without saving any new changes.

Enter your email and password and click Sign in.

Click Agree to establish the connection.

The new connection is now successfully added to your account. It will be applied to the current source or destination app, if you created it within a flow. Otherwise, you may proceed to register the connection with an integration.