Overview

This guide walks through obtaining an access token from Purpl API using the client credentials flow. You’ll log in, create an OAuth Client Application, then request a token and use it in API calls.

<aside> ℹ️

The API root URL differs between test and production. Keep the API root configurable in your integration.

Production: https://api.purplme.com Test: https://api.test.purplme.com

</aside>

1) Access the API Test Environment

• Go to the API Root
  • Production: https://api.purplme.com
  • Test: https://api.test.purplme.com
• Use the credentials you were provided to sign in.

<aside> 🔐

Recommendation: After first login, change the password to a strong value (12+ characters) at your User Instance page: User Instance.

</aside>

2) Create your OAuth Client Application

• Navigate to the Application List
  • Production: https://api.purplme.com/applications/
  • Test: https://api.test.purplme.com/applications/
• Create a new Application for your integration.
• Name the Application.
• Choose Client ID and Client Secret:
  • You can keep the randomly generated values or set your own.
  • If you set your own, make the Client Secret hard to guess.

<aside> ⚠️

Important: Copy the Client Secret before saving. It won’t be shown again. If lost, delete the Application and create a new one.

</aside>

You’ll use the resulting client_id and client_secret to request tokens.

3) Retrieve an access token