How do I create an API key?
Updated · API
An API key lets your own code read your stores and reviews. Each key shows once, when you create it.
Create a key
- In the sidebar, under API, open Keys.
- Select Create key.
- Enter a Name for the app that will use it.
- Under Scopes, check only what the app needs.
- Select Create key, then copy the key. It shows only this once.
Scopes
- Read account (
me:read) - Read your stores (
store:read) - Read your reviews (
store:reviews) - Send orders (
store:orders) - WordPress plugin (
plugin:auth)
A key with WordPress plugin belongs to one store, so you also pick a Store. Read the vendor directory and Read all reviews are for partner accounts.
Use the key
Send your key as Authorization: Bearer pk_live_… or as X-Api-Key. Public keys start with pk_live_ and plugin keys with prp_. Every endpoint lives under https://pepreviewpro.com/api/v1. The full reference, with examples, is in Docs under API.
Change or revoke a key
In Keys, open a key's menu and select Edit scopes or Revoke. A revoked key stops working right away.
Was this helpful?