Connecting to Yotpo

To authenticate to Yotpo, you can use the OAuth 2.0 client credentials flow with your Yotpo AppKey and AppSecret.

Using OAuth Authentication

To use the Yotpo API, you need a Yotpo store account with an AppKey and AppSecret. You can find these credentials in the Yotpo dashboard under Account Settings > Store.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuthClient.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
• OAuthClientId: Set this to your Yotpo AppKey.
• OAuthClientSecret: Set this to your Yotpo AppSecret.

Example connection string:

Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;

Available Tables

The Yotpo API Profile provides access to reviews, products, and store data across 6 specialized tables:

• Reviews - Customer reviews for your Yotpo application, including star ratings, content, sentiment, and moderation status.
• Products - Product catalog synchronized with Yotpo, including names, descriptions, review scores, and category information.
• ProductBottomLine - Aggregated review bottomline summary (total reviews, average score) for a specific product by external ID or SKU.
• Orders - Store orders with line items, fulfillment records, and customer details.
• Customers - Store customer profiles with contact information, marketing opt-in status, and list memberships.
• Collections - Product collections defined in the store, including Yotpo internal IDs and merchant collection IDs.

Usage Examples

Reviews:

SELECT * FROM Reviews

Products:

SELECT * FROM Products

ProductBottomLine:

SELECT * FROM ProductBottomLine WHERE ExternalProductId = 'my-product-sku'

Orders:

SELECT * FROM Orders

Customers:

SELECT * FROM Customers

Collections:

SELECT * FROM Collections

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 OAuthClient. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD
CallbackURL	Identifies the URL users return to after authenticating to API via OAuth (Custom OAuth applications only).
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, REFRESH, GETANDREFRESH
OAuthAccessToken	Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
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. (Custom OAuth applications only.).
OAuthExpiresIn	Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthRefreshToken	Specifies the OAuth refresh token used to request a new access token after the original has expired.
OAuthSettingsLocation	Specifies the location of the settings file where OAuth values are saved.
OAuthTokenTimestamp	Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.
OAuthVerifier	Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.