Registering your integration & opening a test account
If you applied to become a technology partner and received approval from our team, you can now register your app/s and get credentials to use the technology partner APIs.
To get started, you will need a Yotpo test account. If you do not already have one, start by signing up for a free account here. We will upgrade this account for you as part of the registration process below.
Each ‘app’ will have its own unique set of credentials that will allow you to access the APIs on behalf of merchants (see the Authenticating with OAuth 2.0 section for more information). You may want to register multiple apps in order to have separate testing and production environments of the integration, or in order to have separate redirect URLs for different environments on your end. If you are integrating with several Yotpo products (e.g. Reviews, Loyalty and SMS) using the tech partner APIs, you should use a single app and consider exposing data in your integration only when the data for a specific product exists, indicating that the merchant has the specific product.
| Required info | Description | Supported Data Types | Example |
|---|---|---|---|
| Developer Name | Developer (company) public name | String, up to 40 characters | AdRoll |
| Developer Contact URL | URL for merchants to contact the developer (both sales & support). We recommend adding UTMs for your marketing/partnership tracking | Valid URL | https://www.adroll.com/?utm_source=yotpo&utm_medium=partner&utm_campaign=integration_listing |
| Developer Contact Email | Email address for merchants to contact the developer (both sales & support) | [email protected] | |
| Technology Name | The name of the technology you are integrating with Yotpo. Should be the same as the Developer Name if you are developing on behalf of your own technology | String, up to 40 characters | AdRoll |
| Technology Description | Short description of the service provider | String, up to 256 characters | AdRoll provides companies with the tools to retarget high-intent customers with the right ads at the right time. With their AI-powered marketing tech, brands can reach the right audiences via email, social media, and ads. |
| Application Name | App Public Name | String, up to 40 characters | AdRoll |
| Application Icon | Small logo/icon in square dimensions and with a transparent background | 40x40 or 60x60px square logo in SVG format (or 2 separate PNG files in 2x quality) with transparent background | https://www.svgrepo.com/show/354610/adroll.svg |
| Short Description | Short description of the app for integration strip / pop up (please clearly describe what the integration does) | String, up to 150 characters | The integration between AdRoll and Yotpo leverages advanced AI to intelligently incorporate the best product review snippets and star ratings into personalized ad campaigns. |
| Long Description | Long description of the app for the full integration page (make sure you clearly describe what the integration does) | String, up to 856 characters | The integration between AdRoll and Yotpo leverages advanced AI to intelligently incorporate the best product review snippets and star ratings into personalized ad campaigns. Sell more by connecting your Yotpo account to AdRoll. Bring back lost shoppers, personalize campaigns, and get customers to purchase using powerful social proof. |
| Redirect URL (OAuth) | Users will be redirected back to this page within your product/platform as part of the authentication flow, as described in the next section. Each app can have only one redirect URL, but a developer can have several applications, either for integrating with different Yotpo products or for testing & production. | Valid URL | https://app.adroll.com/integrations/yotpo/auth/ |
| Start Install URL | This will be used for installs that are initiated in the Yotpo admin or the Yotpo integrations page. When clicking “connect”, the user will be redirected to your admin to start the installation flow. You will need to support your app login and your store selector (in case there is more than one) and authorization. | Valid URL | https://portal.adroll.com/app/account/apps |
| Integrated Yotpo Products | Which Yotpo products the integration is relevant for | Keep all that apply from the following list (separated by semi-colon): Yotpo Reviews; Yotpo Visual UGC; Yotpo Loyalty & Referrals; Yotpo SMSBump; Yotpo Subscriptions | Yotpo Reviews |
| Partner Categories | Which are the top 3 categories from the list that apply to your company / the technology that you are integrating with Yotpo? | Keep all that apply from the following list (separated by semi-colon): Ads; BI & Analytics; Chat & Messenger; Social Media Marketing; Data & Automation; ECommerce Platform; Email Marketing; Gift Cards; Help Desk & CRM; In-store & POS; Influencer & Affiliate Marketing; Loyalty & Referrals; Marketing Automation; Mobile App Builder; Mobile Wallet; On-site Engagement; Page Builder & PWA; Payment & Checkout; Product Sampling; Content Syndication Channels; Reviews; On-site Search; SMS Marketing; Subscriptions & Recurring Billing; Sustainability & Impact; Other | Ads; Email Marketing |
| Supported eCommerce Platforms | Which eCommerce platforms the integration supports from the list (if limited to certain platforms, otherwise respond "All") | Keep all that apply from the following list (separated by semi-colon): Shopify; Shopify Plus; BigCommerce; Adobe Commerce (Magento); Salesforce Commerce; WooCommerce; and more. | Shopify, Adobe Commerce (Magento), Salesforce Commerce, BigCommerce, Woocommerce, and more. |
| App Availability | Which Partner Plans / Custom Fees are required to use the integration | String, up to 256 characters | Integration is available for free on all AdRoll plans. |
| App Type | Indicate if the specific app is used for Production or Testing | Respond with one of the following: Production / Testing | Production |
| Yotpo Test Account | The API Key or Email used to open the Yotpo account | API Key or Email used to open the Yotpo account | [email protected] |
Want to create multiple apps?
You might want to create multiple apps for testing purposes or for different environments on your end. Please send the details for each app separately and ensure it has a unique name and redirect URL.
Once done, please send these details to [email protected]. Our team can create the app for you and send you your Application ID (also known as "Kong Client ID”) and Application Secret. Please keep these credentials secure as they will be used in the API authentication process, as described in the next section.
Updated about 1 year ago