Getting Started

Quick Start

Follow these four steps to make your first API call.

1. 1

   Create your account

   Sign up at ploints.space/signup and complete the onboarding wizard to set up your business profile.

2. 2

   Navigate to Integrations

   Go to Dashboard → Integrations in your Ploints dashboard.

3. 3

   Copy your API key

   Click Generate Key to create a new API key. Copy it and store it securely. You will not be able to view it again.

4. 4

   Make your first request

   Award points to a customer using a simple POST request.

Your First Request

Award 100 points to a customer using curl:

curl -X POST https://ploints.space/api/v1/points/award \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "customerEmail": "customer@example.com",
    "amount": 100,
    "description": "Welcome bonus"
  }'

Successful response:

{
  "success": true,
  "data": {
    "customerEmail": "customer@example.com",
    "pointsAwarded": 100,
    "newBalance": 100
  }
}

Authentication

All API requests require a Bearer token in the Authorization header. Your API key identifies your business and scopes all operations to your account.

Authorization: Bearer pk_live_abc123...

Never expose your API key in client-side code. All API calls should be made from your backend server.

Base URL

All API endpoints use the following base URL:

https://ploints.space/api/v1

Rate Limits

API rate limits depend on your plan:

Rate-limited requests return a 429 Too Many Requests status code with a Retry-After header.