API Documentation

Build powerful integrations with ClaimPort's REST API

Authentication

Secure API key authentication with SHA-256 hashing and rate limiting.

REST API Endpoints

Products, orders, claims, and analytics endpoints with bulk support.

Security

Enterprise-grade security with IP whitelisting and brute force protection.

Rate Limits

Plan-based rate limits and usage tracking.

Authentication

All API requests require authentication using an API key. Create keys in Settings → API (Professional plan or higher).

# Using X-API-Key header (recommended)
curl -H "X-API-Key: cp_live_your_key_here" \
  https://app.claimport.io/api/v1/products
# Or using Authorization header
curl -H "Authorization: Bearer cp_live_your_key_here" \
  https://app.claimport.io/api/v1/products

Security Note

API keys are hashed using SHA-256 and never stored in plaintext. Keys are shown only once at creation - store them securely.

API Endpoints

Base URL: https://app.claimport.io/api/v1

GET/api/v1/productsList all products with pagination and filteringproducts:read
POST/api/v1/productsCreate products (bulk up to 1,000)products:write
GET/api/v1/ordersList orders with status and customer filteringorders:read
POST/api/v1/ordersCreate orders (bulk up to 500)orders:write
GET/api/v1/claimsList claims with filtering optionsclaims:read
POST/api/v1/claimsCreate claims (bulk up to 100)claims:write
GET/api/v1/analyticsBusiness analytics and statisticsanalytics:read

Bulk Import Example

Import up to 1,000 products in a single request. Perfect for syncing from WooCommerce, Shopify, or CSV exports.

curl -X POST https://app.claimport.io/api/v1/products \
  -H "X-API-Key: cp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "name": "Wireless Headphones Pro",
      "sku": "WHP-001",
      "category": "Electronics",
      "price": 149.99,
      "warrantyMonths": 24
    },
    {
      "name": "Smart Watch Series 5",
      "sku": "SWS-005",
      "category": "Electronics",
      "price": 299.99,
      "warrantyMonths": 12
    }
  ]'
# Response
{
  "message": "Created 2 product(s)",
  "created": ["prod_abc123", "prod_def456"],
  "summary": { "total": 2, "created": 2, "failed": 0 }
}

Rate Limits

PlanRequests/MinuteRequests/DayMax Keys
Professional605,0002
Business12020,00010
Enterprise300100,000100

Security Features

Key Security

  • •SHA-256 hashing (keys never stored in plaintext)
  • •Cryptographic random generation (288 bits entropy)
  • •Timing-safe comparison to prevent timing attacks
  • •Keys shown only once at creation

Access Control

  • •IP whitelisting with CIDR range support
  • •Brute force protection (5 failures = 15 min lockout)
  • •Per-key permission scoping
  • •HTTPS enforcement in production

Monitoring

  • •Full audit logging of all API requests
  • •Real-time usage tracking per key
  • •Last used timestamp and IP
  • •Daily usage counters with auto-reset

Permissions

products:readproducts:write
orders:readorders:write
claims:readclaims:write
analytics:readfull:access

Need Help?

Our developer support team is here to help you integrate ClaimPort.

Contact Developer Support