API Reference

Partner API Overview

Comprehensive API documentation for integrating with the CHeKT Partner platform

Overview

The Partner API is designed to synchronize dealer, site, device, site contact, and monitoring station data with the CHeKT system. This RESTful API enables seamless integration between your platform and CHeKT's security infrastructure.

Two Separate Partner APIs

CHeKT provides two distinct APIs for partner integrations:

  • Partner API (this document): RESTful API for managing dealers, sites, devices, contacts, and monitoring stations (CRUD operations)
  • Partner Event API: Real-time event ingestion API for sending alarms, troubles, and arming events with media

Each API has its own authentication method. This document covers the Partner API.

Base URL

All API requests should be made to: https://api.chekt.com

Authentication

The Partner API uses OAuth 2.0 with two different flows depending on the endpoint:

EndpointAuthentication Method
/partner/v1/dealers/connectOAuth 2.0 Authorization Code Flow
All other endpointsOAuth 2.0 Client Credentials Grant (M2M with JWT)

For detailed authentication setup and examples, see the Partner API Authentication guide.

Quick Start

After obtaining an access token, include it in the request header:

Authorization: Bearer {access_token}

Access tokens expire after a period (typically 1 hour). Generate a new token when the current one expires.

Request Tracking

All API endpoints support the optional x-partner-trace-id header for request tracking:

x-partner-trace-id: 550e8400-e29b-41d4-a716-123456789000

This UUID helps track requests across systems for debugging and monitoring purposes.

Query String Parameters

The Partner API supports advanced query string parameters for filtering, sorting, and pagination:

Available Parameters

fields (optional)

  • Specifies column names to retrieve
  • Example: fields=table1.column1,table2.column2

filter (optional)

  • Filter data based on database column values
  • Supported operators:
    • eq (default): Equal to
    • neq: Not equal to
    • lt: Less than
    • lte: Less than or equal to
    • gt: Greater than
    • gte: Greater than or equal to
    • regex: Regular expression match
  • Example: filter=column,value,eq

sort (optional)

  • Specify column to sort by
  • Example: sort=column1

dir (optional)

  • Sorting direction: asc (default) or desc
  • Example: dir=desc

limit (optional)

  • Maximum number of rows to return
  • Example: limit=10

offset (optional)

  • Starting position in results
  • Example: offset=20

Query String Examples

# Select specific fields with filter
/api/resource?fields=col1,col2&filter=col1,value1,eq&sort=col1&dir=asc&limit=10

# Multiple filters
/api/resource?fields=col1,col2&filter=col1,value1,eq&filter=col2,value2,gt&limit=10

API Categories

The Partner API is organized into the following categories:

Next Steps

Common Response Codes

Status CodeDescriptionSolution
200SuccessRequest completed successfully
201CreatedResource created successfully
204No ContentResource deleted successfully
400Bad RequestCheck request payload format
401UnauthorizedRefresh your access token
403ForbiddenVerify your permissions
404Not FoundCheck resource ID

Rate Limiting

To ensure service stability, API requests are subject to rate limiting. Contact CHeKT support if you need higher rate limits for your integration.

API Versioning

The current API version is v1. All endpoints are prefixed with /partner/v1/.

We maintain backward compatibility within major versions. Breaking changes will be introduced in new major versions (e.g., v2).

Document Version

⚠️ This document is subject to change. Current version: 0.8

Recent changes:

  • 0.8 (2025-05-28): Added arming-setting and verification APIs
  • 0.7 (2025-05-23): Updated monitoring station CRUD APIs
  • 0.6 (2025-05-16): Added disconnect API
  • 0.5 (2025-05-15): Updated Contacts APIs
  • 0.4 (2025-05-12): Updated Devices APIs

Support

For API support and questions: