Platform & Extensibility

APIs & SDKs

Build powerful integrations with our comprehensive REST API, real-time webhooks, and developer-friendly SDKs. Connect Hykmah with your existing systems and extend functionality to match your exact needs.

Roles and Permissions platform
KEY FEATURES

Developer-First Integration

REST API

Full-featured REST API covering all platform entities. JSON responses, consistent patterns, and comprehensive documentation for every endpoint.

Webhooks

Real-time event notifications pushed to your endpoints. Subscribe to any event type and receive instant updates as data changes.

SDKs & Libraries

Official SDKs for JavaScript, Python, PHP, and Ruby. Get started quickly with idiomatic code in your preferred language.

Interactive Documentation

Try API calls directly in the browser. Interactive examples, request builders, and live response previews for faster development.

API Keys & OAuth

Flexible authentication with API keys for server-to-server and OAuth 2.0 for user-authorised access. Granular permission scopes.

Rate Limiting

Generous rate limits with clear headers. Burst capacity for spikes and dedicated limits for enterprise accounts.

Versioning

Stable API versions with clear deprecation policies. Migrate at your own pace with long support windows for older versions.

How It Works

Start Building in Minutes

Step 1

Get Your API Key

Create an account and generate your API key from the developer settings. Choose between test and production keys.

Step 2

Explore the Documentation

Browse our comprehensive API reference. Try endpoints directly in the browser with your test key.

Step 3

Install an SDK

Choose your language and install our official SDK via npm, pip, composer, or gem. Pre-configured with best practices.

Step 4

Build Your Integration

Start making API calls. Use our sample code, Postman collections, and integration guides to accelerate development.

Technical Details

Enterprise-Ready API Infrastructure

API Endpoints

  • 200+ REST endpoints
  • Full CRUD operations
  • Bulk operations support
  • Filtering and pagination
  • Field selection (sparse fieldsets)
  • Relationship expansion
  • Search and query endpoints
  • Aggregate and reporting endpoints

Webhook Events

  • 100+ event types
  • Real-time delivery
  • Retry with exponential backoff
  • Event replay capability
  • Signature verification
  • Event filtering rules
  • Delivery logs and debugging
  • Dead letter queue

Rate Limits

  • Standard: 1,000 requests/minute
  • Professional: 5,000 requests/minute
  • Enterprise: 20,000 requests/minute
  • Burst: 2x limit for 10 seconds
  • Webhook delivery: Unlimited
  • Bulk operations: 100 records/request

SDKs Available

  • JavaScript/TypeScript (npm)
  • Python 3.8+ (pip)
  • PHP 8.0+ (composer)
  • Ruby 2.7+ (gem)
  • Java 11+ (maven)
  • Go 1.18+ (go get)
  • Postman Collection
  • OpenAPI 3.0 Specification
PRODUCTS THAT USE THIS CAPABILITY

API Access Across All Products

Create jobs, dispatch technicians, update statuses, and sync with external scheduling systems.

Learn more

Manage subscriptions, process payments, handle upgrades, and integrate with payment gateways.

Learn more

Sync products, process orders, manage inventory, and integrate with fulfilment systems.

Learn more

Create events, manage tickets, validate entries, and sync with marketing platforms.

Learn more
Related Capabilities

Works Best With

Automation & Scripting Engine

Trigger workflows via API or call external APIs as actions within your automations.

Learn More →

Integration Fabric

Pre-built connectors for common platforms, built on the same API infrastructure available to developers

Learn More →

Low-Code Data Model & UI

Schema introspection endpoints expose your custom entities and fields directly through the API.

Learn More →

Ready to Build?

Talk to our team about integrating Hykmah with your existing systems and workflows.

Book a Technical Discussion