API Reference

QikCard API Reference

Complete API documentation for integrating QikCard into your applications. RESTful endpoints, WebSocket events, and comprehensive examples.

Base URL
https://api.theqikcard.com/v1
Authentication
Bearer token in Authorization header
Rate Limits
1000 requests per minute

API Endpoints

POST
/api/v1/events
Events

Create a new event

GET
/api/v1/events/{id}
Events

Get event details

POST
/api/v1/scanners
Hardware

Register a new QikPoint scanner

POST
/api/v1/interactions
Interactions

Record a card interaction

GET
/api/v1/analytics/{eventId}
Analytics

Get event analytics data

POST
/api/v1/nfts/mint
NFTs

Mint NFT rewards

Code Examples

// Initialize QikCard SDK
import { QikCard } from '@qikcard/sdk';

const qikcard = new QikCard({
  apiKey: 'qk_live_...',
  environment: 'production'
});

// Create an event
const event = await qikcard.events.create({
  name: 'Web3 Developer Conference',
  startDate: '2025-03-15T09:00:00Z',
  endDate: '2025-03-17T18:00:00Z',
  location: {
    name: 'San Francisco Convention Center',
    address: '747 Howard St, San Francisco, CA 94103'
  },
  settings: {
    requireRegistration: true,
    enableNFTRewards: true,
    maxParticipants: 2500
  }
});

console.log('Event created:', event.id);

Authentication

API Keys
QikCard uses API keys to authenticate requests. Include your API key in the Authorization header.

Test Environment

Authorization: Bearer qk_test_...

Production Environment

Authorization: Bearer qk_live_...
Error Handling

The API uses conventional HTTP response codes to indicate success or failure:

Success Codes

  • 200 - OK
  • 201 - Created
  • 204 - No Content

Error Codes

  • 400 - Bad Request
  • 401 - Unauthorized
  • 404 - Not Found
  • 429 - Rate Limited
  • 500 - Server Error

Official SDKs

JavaScript/TypeScript
Full-featured SDK for Node.js and browser environments
npm install @qikcard/sdk
Python
Pythonic SDK for backend integrations and data analysis
pip install qikcard

Need Help with the API?

Our developer support team is here to help you integrate QikCard successfully.