Automation Method: send my orders through 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 retrieving orders from the last three months to collect relevant reviews. 
  • Subscribed to the Verified Reviews solution after September 2022

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, identifier, 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/am/oauth2/alpha/access_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/am/oauth2/alpha/access_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.

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 wish to collect only brand reviews, you need to remove the product variable from your API call.

🖥️ Historical Platform

We invite you to share the following documentation with your technicians:

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