Getting authenticated

We’ll be using the sandbox environment of our API. The sandbox lets you develop the PG Rewards API using mock data. The sandbox environment's URL is https://sandbox.pgecom.com/signin

🔑 Getting an API Key

Sign up or log in to your sandbox account at: https://sandbox.pgecom.com/signin
Navigate to Settings > Developer Setting
Click on Generate New Credentials to get new credentials

🎉 Make your first request

Generate your first token

POST https://sandbox.pgecom.com/api/v1/token

Request Body

Name	Type	Description
apiKey*	String
secretKey*	String

Name

Type

Description

apiKey*

String

secretKey*

String

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCIIkpXVCJ9.eyJ1c2VySUQiOiI1ZjU2ZGZhMy1hNDE1LTQ4MTgtODI3NS00GZjNjNlY2UzZmQiLCJpc0FjdGl2ZSI6dHJ1ZSwiaXNBZ2VudCI6dHJ1ZSwiaXNTdXBlckFkbWluIjpmYWxzZSwiYWdlbnRTZXR0aW5nIjp7Il9fdHlwZW5hbWUiOiJTZXR0aW5ncyIsIl9sYXN0Q2hhbmdlZEF0IjoxNjUxMDQ1MDcwMDM1LCJfdmVyc2lvbiI6MSwidG9wVXBGZWVzIjo0LCJ2aXJ0dWFsQ2FyZEZlZXMiOjExLCJ1cGRhdGVkQXQiOiIyMDIyLTA1LTIwVDAxOjIwOjI5LjgzMloiLCJ1c2VySUQiOiI1ZjU2ZGZhMy1hNDE1LTQ4MTgtODI3NS00NGZjNjNlY2UzZmQiLCJ0cmFuc0ZlckZlZXMiOjMsImNyZWF0ZWRBdCI6IjIwMjItMDQtMjdUMDc6Mzc6NTAuMDM1WiIsImlkIjoiNWY1NmRmYTMtYTQxNS00ODE4LTgyNzUtNDRmYzYzZWNlM2ZkIiwiY2FyZEZlZXMiOjV9LCJhZ2VudEJhbmtSZXdhcmRGZWVzIjo3LCJ0b3B1cEZlZXMiOjAuNDEsImFnZW50VHJhbnNGZXJGZWVzIjoxLCJpc1N0cmlwZUlzc3VpbmdFbmFibGVkIjp0cnVlLCJpc0JhbGFuY2VFbmFibGVkIjp0cnVlLCJhZ2VudFBheVBhbEZlZXMiOjQsImNhc2hBcHBGZWVzIjozLCJpc1RvcFVwRW5hYmxlZCI6dHJ1ZSwiaWQiOiI3ODFiYTliOS1lMDJkLTQ3ODktYTRhNi0wNjNiM2UyNTg1N2MiLCJ6ZWxsZUZlZXMiOjMsImZWVzIjo1LCJwYXlwYWxGZWVzIjo4LCJpc1VTQUJhbmtSZXdhcmRzRW5hYmxlZCI6dHJ1ZSwidmlydHVhbENhcmRGZWVzIjo4LCJ1cGRhdGVkQXQiOiIyMDIyLTA2LTMwVDEwOjE3OjIyLjkyMVoiLCJpc1BheVBhbEVuYWJsZWQiOnRydWUsImlzTW9uQ2FzaEVuYWJsZWQiOnRydWUsImFnZW50VG9wdXBGZWVzIjoxLCJpc1N0cmlwZUVuYWJsZWQiOnRydWUsImlzVmlydHVhbENhcmRFbmFibGVkIjp0cnVlLCJhZ2VudENhcmRGZWVzIjo0LCJpc1BheW1lRW5hYmxlZCI6dHJ1ZSwiaWF0IjoxNjU2ODM1MTE4LCJleHAiOjE2NTk0MjcxMTh9.PQwvdewWXJ3UROAleG8Q9pEkeQWtYSaawbtT4EaUOg8"
}

{
    "message": "User not found",
    "status": 400
}

{
    "message": "API Secret Key is invalid",
    "status": 401
}

Congrats, you've authenticated and made your first request!

PreviousIntroduction NextSandbox Environment

Last updated 2 months ago

Generate your first token

POST https://sandbox.pgecom.com/api/v1/token

Request Body

Name	Type	Description
apiKey*	String
secretKey*	String

Name

Type

Description

apiKey*

String

secretKey*

String

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCIIkpXVCJ9.eyJ1c2VySUQiOiI1ZjU2ZGZhMy1hNDE1LTQ4MTgtODI3NS00GZjNjNlY2UzZmQiLCJpc0FjdGl2ZSI6dHJ1ZSwiaXNBZ2VudCI6dHJ1ZSwiaXNTdXBlckFkbWluIjpmYWxzZSwiYWdlbnRTZXR0aW5nIjp7Il9fdHlwZW5hbWUiOiJTZXR0aW5ncyIsIl9sYXN0Q2hhbmdlZEF0IjoxNjUxMDQ1MDcwMDM1LCJfdmVyc2lvbiI6MSwidG9wVXBGZWVzIjo0LCJ2aXJ0dWFsQ2FyZEZlZXMiOjExLCJ1cGRhdGVkQXQiOiIyMDIyLTA1LTIwVDAxOjIwOjI5LjgzMloiLCJ1c2VySUQiOiI1ZjU2ZGZhMy1hNDE1LTQ4MTgtODI3NS00NGZjNjNlY2UzZmQiLCJ0cmFuc0ZlckZlZXMiOjMsImNyZWF0ZWRBdCI6IjIwMjItMDQtMjdUMDc6Mzc6NTAuMDM1WiIsImlkIjoiNWY1NmRmYTMtYTQxNS00ODE4LTgyNzUtNDRmYzYzZWNlM2ZkIiwiY2FyZEZlZXMiOjV9LCJhZ2VudEJhbmtSZXdhcmRGZWVzIjo3LCJ0b3B1cEZlZXMiOjAuNDEsImFnZW50VHJhbnNGZXJGZWVzIjoxLCJpc1N0cmlwZUlzc3VpbmdFbmFibGVkIjp0cnVlLCJpc0JhbGFuY2VFbmFibGVkIjp0cnVlLCJhZ2VudFBheVBhbEZlZXMiOjQsImNhc2hBcHBGZWVzIjozLCJpc1RvcFVwRW5hYmxlZCI6dHJ1ZSwiaWQiOiI3ODFiYTliOS1lMDJkLTQ3ODktYTRhNi0wNjNiM2UyNTg1N2MiLCJ6ZWxsZUZlZXMiOjMsImZWVzIjo1LCJwYXlwYWxGZWVzIjo4LCJpc1VTQUJhbmtSZXdhcmRzRW5hYmxlZCI6dHJ1ZSwidmlydHVhbENhcmRGZWVzIjo4LCJ1cGRhdGVkQXQiOiIyMDIyLTA2LTMwVDEwOjE3OjIyLjkyMVoiLCJpc1BheVBhbEVuYWJsZWQiOnRydWUsImlzTW9uQ2FzaEVuYWJsZWQiOnRydWUsImFnZW50VG9wdXBGZWVzIjoxLCJpc1N0cmlwZUVuYWJsZWQiOnRydWUsImlzVmlydHVhbENhcmRFbmFibGVkIjp0cnVlLCJhZ2VudENhcmRGZWVzIjo0LCJpc1BheW1lRW5hYmxlZCI6dHJ1ZSwiaWF0IjoxNjU2ODM1MTE4LCJleHAiOjE2NTk0MjcxMTh9.PQwvdewWXJ3UROAleG8Q9pEkeQWtYSaawbtT4EaUOg8"
}

{
    "message": "User not found",
    "status": 400
}

{
    "message": "API Secret Key is invalid",
    "status": 401
}

Congrats, you've authenticated and made your first request!