Skeepers
API docs by Redocly

Purchase Events API (1.0.0)

Download OpenAPI specification:Download

Introduction

Welcome to the Skeepers Purchase Events API documentation!

This API allows you to easily share your business' purchase events with Skeepers, including online store orders and in-store purchases.

A key step towards gathering valuable User-Generated Content (UGC)! This data empowers Skeepers to gain deeper insights into your customers and their recent purchases, enabling us to send them personalized invitations to collect precious feedback.

This documentation provides clear examples and guidance on how to use the API's individual endpoints.

API URL

The base URL for accessing the Purchase Events API is:

https://api.skeepers.io/purchase-event/

Authentication

Authentication is required to use the Purchase Events API. Follow the step-by-step guide below to retrieve your API credentials, obtain an access token, and use it to authenticate your requests.

1. Retrieve your API Credentials

To begin, log in to your Ratings & Reviews account: https://app.netreviews.eu/

  1. Navigate to the Collect reviews > Review request sending menu.
  2. Proceed to the API tab.
  3. Click the Create your API account button to generate your credentials.
  4. Locate your API credentials (Client ID and Client secret) and keep them handy for the next step.

2. Obtain an Access Token

To obtain an access token, make a POST request to the authentication endpoint as follows:

Authentication endpoint

https://auth.skeepers.io/am/oauth2/alpha/access_token

Header Parameters

Authorization: Basic <base64 encoded "clientId:clientSecret">
Content-Type: application/x-www-form-urlencoded

Replace <base64 encoded "clientId:clientSecret"> with the Base64-encoded value of your API credentials (Client ID and Client secret).

Request Parameters

grant_type: client_credentials
scope: openid

Example

POST https://auth.skeepers.io/am/oauth2/alpha/access_token HTTP/1.1
Authorization: Basic <base64 encoded "clientId:clientSecret">
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&scope=openid

3. Authenticate your Requests

Once you've obtained the access token, include it in the Authorization header of all your requests to the Purchase Events API as follows:

Authorization: Bearer <access_token>

Replace <access_token> with the actual access token you received from the previous step.

Great job! You are now ready to make authenticated requests to the Purchase Events API.

Let's explore the methods below!

Submit purchase events

Submit one or multiple purchase events within a single request.

Note: Maximum 50 purchase events per request.

path Parameters
website_id
required
string <uuid>
Example: d0accd7e-32c8-11ee-be56-0242ac120002

The ID of the website.

Request Body schema: application/json
required

Array of purchase events

Array
purchase_reference
required
string [ 1 .. 50 ] characters

The reference of the purchase.

purchase_date
required
string <date-time>

The date of the purchase.

price
number
Default: 0

The amount of the purchase.

required
object (Consumer Schema)

Information about the consumer who made the purchase.

Array of objects or null (Product Schema)

List of products associated with the purchase event.

required
object (Sales Channel Schema)

Information about where the purchase was made.

object (Solicitation Parameters Schema)

Setup for the review request that will be sent.

Array of objects or null (Custom Fields Schema)

Custom fields associated with the purchase event.

Responses

Request samples

Content type
application/json
Example
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]