If you have been using our old version of the API to send us your orders and collect customer reviews, please note that a new, more efficient version is now available.
Why switch to the new version?
- The old API will soon be deactivated: to continue collecting reviews uninterrupted, it is essential to migrate to the new version in the coming months.
- Improved technical performance.
- Redesigned setup screens: review collection configuration is more intuitive and accessible.
- A new tracking page: easily view the status of your review requests.
- Self-service management of solicitation emails: gain more flexibility to customize your sends and tailor your collection strategy.
How to check which API version you’re using?
Compare the screenshots below with the menu in your Verified Reviews account:
| ✨ New API Version | 🖥️ Legacy API Version |
Once migration is complete, the review request history tied to the old API will no longer be accessible. Be sure to export data if necessary.
The new API does not allow excluding specific products from review collection.
Implementing the new API
Follow the steps below:
- First, contact our team: technical actions must be performed on our side first.
- Once our team confirms validation, it’s essential to disable the old API call. This prevents duplicate order transfers and avoids soliciting customers twice.
-
After the new setup pages are available in your Verified Reviews account,
go to the left sidebar
Collect Reviews, then Configuration.
- Then choose API in the configuration banner.
- Click the button to create your API account.
- Once the account is created, you can view your API settings: URL, client ID, and client secret.
- Then generate your secret key by clicking View key.
If needed, you can always regenerate this key later.
Structure and Send the Request
The Skeepers API uses OpenId Connect Client Credential grant to authenticate requests. This method does not authenticate a specific user but instead verifies credentials and returns a generic access_token.
This authorization (OpenId Connect Client Credential grant) is used for machine-to-machine authentication.
https://auth.skeepers.io/realms/skeepers/protocol/openid-connect/token
-
Authorization: Set to
Basic <base64 encoded "clientId:clientSecret"> -
Content-Type: Set to
application/x-www-form-urlencoded
-
grant_type: Set to
client_credentials -
scope: Set to
openid
POST https://auth.skeepers.io/realms/skeepers/protocol/openid-connect/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Authorization: Basic <base64 encoded "clientId:clientSecret">
grant_type="client_credentials" & scope="openid"
Please click this link (Swagger) to access the guide for configuring and simulating your purchase or service proof requests. This is where, in the Authentication section, you will need to add your website ID:
Find your integration codes
To find your secret key and your website ID:
- Go to the left-hand menu in Verified Reviews
Account Management, then
My Account.
- The information is then on the right side of the page in the Integration Code section.
Tracking the collection
You now have a new tracking page for your review collection. This allows you to verify order/service submission and review request status.
To access it, go to the left sidebar Collect Reviews, then Review Requests Follow-up.
If you want to collect only brand reviews, remove the product variable from your API call.
Customize your emails
The new version of our API allows you to use the email configurator, enabling you to personalize your review requests to boost collection!
We
invite you to
contact our team
to discuss implementation.