Developer Guide

API Documentation

Integrate Quality Point verification into your systems with our comprehensive API

Integration Process

Follow these steps to integrate Quality Point API into your system

1

Get API Credentials

Register for a manufacturer account and obtain your API key and secret.

2

Set Up Webhooks

Configure webhook endpoints to receive real-time notifications.

3

Test Integration

Use our sandbox environment to test your integration before going live.

4

Go Live

Deploy to production and start registering your products.

API Endpoints

Core endpoints for product registration and verification

POST

/api/v1/products/register

Register a new product in the system

Example Request:

{
  "serial_number": "QP123456789",
  "product_name": "Premium Widget",
  "manufacturer_id": "mfg_123",
  "manufacturing_date": "2024-01-15",
  "expiry_date": "2026-01-15"
}

GET

/api/v1/products/verify/{serial}

Verify product authenticity by serial number

Example Response:

{
  "status": "verified",
  "product": {
    "name": "Premium Widget",
    "manufacturer": "ACME Corp",
    "manufacturing_date": "2024-01-15",
    "expiry_date": "2026-01-15",
    "is_authentic": true
  }
}

POST

/api/v1/products/batch-register

Register multiple products in bulk

Example Request:

{
  "products": [
    {
      "serial_number": "QP123456789",
      "product_name": "Premium Widget",
      "manufacturing_date": "2024-01-15"
    }
  ]
}

Authentication

All API requests require authentication using API keys and Bearer tokens.

API Key Authentication

curl -X POST \
  https://api.qualitypoint.net/v1/products/verify \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"serial_number": "QP123456789"}'

Webhook Integration

Receive real-time notifications when products are scanned or reported.

Webhook Payload

{
  "event": "product.scanned",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "serial_number": "QP123456789",
    "user_id": "user_123",
    "location": "Kampala, Uganda",
    "result": "verified"
  }
}

SDKs & Libraries

Use our official SDKs to integrate Quality Point faster

Node.js SDK

npm install @qualitypoint/node-sdk

Python SDK

pip install qualitypoint-python

PHP SDK

composer require qualitypoint/php-sdk

Need Help?

Our developer support team is here to help you integrate successfully