✨ New version: send orders via API

You have the possibility to send your proofs of purchase/service, in complete autonomy, thanks to the API automation method.

Click on the version corresponding to your menu:

✨ New Platform 🖥️ Historical Platform

Other automation methods, such as SFTP or CSV, are also available. (click on the desired method to access the procedure) 

✨ New Platform 

Prerequisites

We recommend that you send us the orders from the last 3 months to collect relevant reviews.

Setup

  1. Go to the left side menu Collect Reviews, then Configuration

  2. Select API in the setup banner.

  3. Click the button to create your API account 

  4. Once the account is created, you can view your API settings: URL, Website ID, and secret key.

  5. Generate your secret key by clicking on View Key.

If you encounter issues, you can regenerate this key.

Structure and Send the Request  

Authentication

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.

Authentication URL

https://auth.skeepers.io/realms/skeepers/protocol/openid-connect/token

Header Parameter
  • Authorization: Set to Basic <base64 encoded "clientId:clientSecret">
  • Content-Type: Set to application/x-www-form-urlencoded
Request Parameter
  • grant_type: Set to client_credentials
  • scope: Set to openid
Example

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"
      
Purchase Event API Swagger

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:

  1. Go to the left-hand menu in Verified Reviews Account Management, then My Account.
  2. The information is then on the right side of the page in the Integration Code section.

Monitor Collection

You can verify the transmission and integration of your purchase/service proofs, as well as the review request status.

To do so, go to the left side menu Collect Reviews, then Review Request Follow-up

If you want to collect only brand reviews, you must remove the product variable from your API call.

Learn more in the API documentation: Submit Purchase Event > solicitation_parameters > purchase_event_type.

Was this article helpful?
3 out of 10 found this helpful