API Access via Public Keys

Integrate your UI without need of a backend

Start Now

PSRESTful is a REST/JSON API service that allows you to access PromoStandards data in a simple and efficient manner.

At its core, it is a fast & reliable proxy service that handles all the complexities of the PromoStandards specification, allowing you to focus on your business logic.

PSRESTful uses several authentication mechanisms. However, Public Keys are a simple and secure way to access the API from your front-end application.

Main use cases include:

  • Real-time inventory access to display in your product detail page. You can find an example here
  • Modify your checkout logic based on real-time inventory
  • Backoffice Order Status tracking
  • Backoffice OSN (Order Shipment Notifications)

How does it work?

It is a three-step process that involves:
  • Generating a public key
  • Adding your domains to Allowed Origins in Account Settings
  • Using the public key to make API requests(adding pub_api_key=YOUR_KEY to query params in your request)

The public key is a unique identifier that is used to authenticate and authorize access to the API.
It is a 32-character string that is generated by the user and stored in the database.

This method will allow you to access the API from your front-end application, such as a website, mobile app, or backoffice application.