Prestashop Integration Framework

# 🔌 PrestaShop Integration Framework APIs

# Overview

Through these various API routes, you can access and integrate PrestaShop store data into your modules and third party services. Here are some key considerations before using the PrestaShop Integration Framework APIs:

  • The PrestaShop Integration Framework APIs support REST.
  • They are versioned and get regular updates. The documentation is always based on the latest production version.
  • You must be registered in our system to receive a valid token in order to query these routes.
  • The APIs are fully documented in an OpenAPI 3.0 compliant documentation.

Contact Us

Our team is here to help you get started with the implementation of PrestaShop CloudSync and PrestaShop Billing APIs. Please click here (opens new window) to set up a meeting with us before proceeding with the integration of your module.

# Getting an Access Token

To query the PrestaShop Integration Framework APIs, you first need to receive a JWT from the Authorization Server. This JWT is issued following the OAuth2 Standard Protocol (opens new window).

  1. Get in touch with PrestaShop Solution Engineers ([email protected]) to get your client credentials.

  2. Call the Account Authorization Server to get your JWT.

    Authorization Server URL (production) : https://oauth.prestashop.com/ (opens new window)

    You can use the library you want for your favorite language. Here is a list of available code libraries at this link (opens new window). If you want to make this with a curl, below is an example of a request to the Authorization Server:

    curl --request POST \
  --url https://oauth.prestashop.com/oauth2/token \
  --header 'Authorization: Basic ZGltaXRyaS5tb3VpbGxhcmRAcHJlc3Rhc2hvcC5jb206VW4gbW90IGRlIHBhc3NlIHRy6HMgY29tcGxpcXXpIDop' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data client_id=provided-by-prestashop \
  --data grant_type=client_credentials \
  --data 'audience=https://api.cloudsync.prestashop.com tech-vendor/provided-by-prestashop' \
    1
    2
    3
    4
    5
    6
    7

The requested audience and scopes may differ depending on the resources you want to request.

# PrestaShop Billing API

# Why Use It?

The PrestaShop Billing API provides a unique entry point to all the different Billing services. It is still under development. 🚧

# Reference documentation

The documentation for the Billing API is available here (opens new window).

# PrestaShop CloudSync APIs

# Why Use It?

Below is a non-exhaustive list of the possibilities offered by powering your modules and services with the PrestaShop CloudSync APIs:

  • Read PrestaShop store information, including products, categories, carts, orders, carriers, prices, currencies, themes, and more.
  • Extend PrestaShop functionality with modules and services based on these data.
  • Add new features to PrestaShop back and front office.
  • Connect PrestaShop with third-party platforms through these APIs.
  • Automate your workflows thanks to CloudSync APIs.

# Reference documentation

The general documentation for CloudSync APIs is available here (opens new window).

#  Expose Raw API Documentation

This API enables you to request all the raw data captured by CloudSync. It exposes 30 tables that contain more than 300 properties.

Expose Raw API Reference Guide (opens new window)

#  Reporting API Documentation

This API enables you to query the status of the latest synchronizations and errors from stores using your modules and services based on CloudSync.

Reporting API Reference Guide (opens new window)

# Tools

PrestaShop also provides you with a range of tools and libraries to speed up the integration of CloudSync APIs into your projects:

#  Expose Raw API Postman Collection

Postman collection dedicated to the Expose Raw API. Include pre-built and saved requests to ease the usage.

Expose Raw API Postman Collection link (opens new window)

#  Reporting API Postman Collection

Postman collection dedicated to the Reporting API. Include pre-built and saved requests to ease the usage..

← Submitting Your Module →