Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.khaime.com/llms.txt

Use this file to discover all available pages before exploring further.

Authentication

The Khaime Partner API uses API key authentication via the X-API-Key header.

API Key Types

TypePrefixUse
Sandboxpk_sandbox_Testing — no real charges
Livepk_live_Production — real payments

Creating API Keys

  1. Log in to app.khaime.com
  2. Go to Settings → API & Integrations
  3. Click Create API Key
  4. Select environment (Sandbox or Live)
  5. Copy the key — it’s shown only once

Using Your Key

Include the key in every request:
curl -H "X-API-Key: pk_sandbox_bff301298a..." \
     -H "Content-Type: application/json" \
     https://api.khaime.com/api/v1/partner/products

Key Management

Programmatic Key Management

MethodEndpointDescription
POST/create-api-keyCreate new API key
GET/api-keysList all keys
DELETE/api-keys/:idRevoke a key
PUT/api-keys/:id/toggle-statusEnable/disable key
PUT/api-keys/:id/webhookSet webhook URL
POST/api-keys/:id/regenerate-webhook-secretRotate webhook secret
Key management endpoints require your user auth token (x-id-key header), not the API key itself. These are typically called from your dashboard, not from integration code.

Security Best Practices

  • Never expose API keys in client-side code or version control
  • Use environment variables to store keys
  • Use sandbox keys for development and testing
  • Rotate keys periodically
  • Revoke compromised keys immediately