API Data Provider - Online Help

Connecting to Jumpseller

Jumpseller enables authentication to its service via the OAuth protocol.

Using OAuth Authentication

To authenticate to Jumpseller, you will first need to register a Jumpseller OAuth application for your account. To do so, navigate to the Apps section from within the administrative section of your online store, then click 'Developers' > 'Add Application' and fill out the form for your application. Your app will be assigned a Client ID and a Client Secret. After setting the following in the connection string, you are ready to connect:

  • AuthScheme: Set this to OAuth.
  • OAuthClientId: Set this to the Client ID assigned to your application
  • OAuthClientSecret: Set this to the Client Secret assigned to your application
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • CallbackURL: Set this to the Redirect URI that is specified in your app settings

Example connection string

Profile=C:\profiles\Jumpseller.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
AuthScheme The scheme used for authentication. Accepted entries are None or OAuth.
Allowed values are: BASIC, NONE, NTLM, OAUTH, OAUTH_CLIENT, APIKEY
CallbackURL The URL users return to after authenticating to API via OAuth.
InitiateOAuth Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
Allowed values are: OFF, GETANDREFRESH, REFRESH
OAuthClientId Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9300.0