Skip to main content

Review apps platforms integration

How to test integrations with Review apps?

Note: you should have your review app deployed first.

Also don't forget that review apps take some time to wake up, so your app might not load at first time.

Shopify

Demo video: https://www.loom.com/share/ea8d4cb9f99140838777dd2defcbe97c

Instructions for developer: \

  • Go to developer.shopify.com and sign in using lastpass.

  • Go to “Apps” in left sidebar menu

  • Create new app (or use your existing one)

    • I suggest you to create one review app for yourself and name it smth like

      yerassyl-review (name-review), so that others know it is yours and they should not touch it

  • Go to App setup in tab bar menu

alt_text

  • Under the URL’s section, put your review app urls as shown in screenshot below. Pay attention that you should put your deployed review app urls and change app-type (ex: form-builder) accordingly.

alt_text

  • Scroll down and find the App Credentials section, copy your credentials.
  • In Heroku dashboard go to Configuration of your review app
  • Add QA_SHOPIFY_APP_ID=your-api-key and QA_SHOPIFY_APP_SECRET=your-api-secret config variables that you obtained before.
  • Restart heroku dynos for review app.

Testing

Now you should be able to test your review app using shopify. Steps are the same as for staging or alpha. \ For ex you would use url like this to initiate installation flow: \

https://powr-review-6538.herokuapp.com/plugins/form-builder/shopify_authenticate?shop=your-shop-url.myshopify.com

Replace your-shop-url.myshopify.com with your shopify store url.

Wix

Demo video: https://www.loom.com/share/fba4b6106119465a89d5b08ef1c9bb8b

Note: You won't be able to test chat, notificationBar, popup (apps that do not have specific location) apps with review app as of now). Please use staging for them.

  • Go to My Apps dashboard and look for apps that have “Review App” in their name (not [Review] Popup etc, they are different apps). There are 4 apps in total.
  • If an app contains someone's name in it, then don’t touch it, this app is in use. Also if you are using/testing one of the review apps put your name into (ex: Review app (Yerassyl)). Don't forget to release an app by removing your name from it after you are done using it.

alt_text

Once you have chosen an app

  • Go to the Components section in the sidebar menu and edit “Review app” widget you will see there.

alt_text

  • Scroll down to Widget Endpoints and change urls according to your deployed review app (see screenshot below)

alt_text

Component URL: https://review-app-url/plugins/app-type/wix_cached_view

Mobile URL: same as Component URL

App Settings URL: https::/review-app-url/plugins/app-type/wix_settings

Note: don't forget to change form-builder to your app-type.

  • Go to OAUTH section in sidebar menu and copy App Id and App Secret Key
  • In Heroku dashboard go to Configuration
  • Add QA_WIX_APP_ID=AppId, and QA_WIX_APP_SECRET=AppSecretKey to config variables
  • Restart heroku dynos for review app.

Now you should be able to test review apps with wix.

Bigcommerce \ \ NOTE: not fully ready

\ Demo video: https://www.loom.com/share/7ffe3017c614490aa253cf00f0483ec8 \

  • Sign in into bigcommerce.com using last pass ([email protected])
  • Chose a store you want to test (or you can create your own in manage.bigcommerce.com)
  • Sign in into developer.bigcommerce.com and go to “My Apps”
  • Create a new app, name it - Review App (your-name), put your name so that other developers know that you are the owner of this review app and that they should not touch it. Also do not touch someone’s review app (coz they might be testing something at the moment).
  • Fill in details like shown in screenshot, most important is 16774 Partner ID. Don’t submit an app, but just provide these details.

alt_text

  • Under “Callback URLs put smth like these: \
Auth Callback URL: https://powr-review-6538.herokuapp.com/bigcommerce/oauth/bigcommerceStaging


Load Callback URL:


https://powr-review-6538.herokuapp.com/bigcommerce/load/bigcommerceStaging


Change base url accordingly.

  • Under “OAuth scopes” set Products and Content to “Modify, \ And set Information Settings to “Read Only”

  • Click “Update & Close”

    Note: If stuck, take a look at existing Review App (Yerassyl)

  • Go to “My Apps” list, find your app, click on “View Client ID” and copy client id and secret

  • Go to Heroku Dashboard settings and set config vars: \ BIGCOMMERCE_REVIEW_CLIENT_ID: Client Id 

    bigcommerce_app_secrets_bigcommerceReview: Client Secret

  • Restart your review app dynos

Now you should be able to to test your app:

You do it by using urls smth like this: \ \ https://store-vo9bhwjfo7.mybigcommerce.com/manage/marketplace/apps/29772

Note: pay attention that you will need to change store-vo9bhwjfo7 to your, and 29772 to id of your app. To find the id of your review app, just hover it in “My Apps'' list and look at the url on the left bottom corner. You will get it.