AlkaShift Icon
AlkaShift Scheduler
AlkaShift Platform

Developer Documentation & API Reference

Comprehensive REST API documentation covering 130+ FastAPI endpoints, WebSocket real-time protocols, POS webhook HMAC verification, and geocoding services.

REST API & SDK Quickstart
curl -X POST https://api.alkashift.com/v1/auto-schedule \
  -H "Authorization: Bearer sec_tok_live_8912" \
  -H "Content-Type: application/json" \
  -d '{
    "location_id": "loc_downtown_cafe",
    "solver": "GOOGLE_OR_TOOLS_CPSAT",
    "allocation_policy": "EQUALIZE_HOURS_FAIRNESS",
    "overtime_mode": "STRICT_40H_GATE",
    "date_range": { "start": "2026-09-14", "end": "2026-09-20" }
  }'
OpenAPI 3.1 Specs Available
Rate Limit: 5,000 req/min
99.99% Uptime SLA

OpenAPI 3.1 & Interactive Swagger

Auto-generated interactive API documentation for over 130 endpoints across Schedules, Shifts, Kiosks, Tip Pools, Chat, and Timesheets.

WebSocket Real-Time Chat & Telemetry Protocol

Specification for bi-directional WebSocket connections (/api/chat/ws/{channel_id}, /api/shifts/ws/) with JWT authentication and pub/sub JSON schemas.

POS Webhook HMAC-SHA256 Verification

Implementation guides for signing and verifying incoming webhook payloads from Toast, Square, and Clover using constant-time hash comparison.

OpenStreetMap Geocoding & Locations API

REST endpoints to proxy OpenStreetMap Nominatim queries and configure PostGIS spatial coordinates for branch venues.

Official TypeScript & Python SDKs

Production-ready client libraries with type-safe request/response models, automated token refresh, and exponential backoff retry handlers.

Ready to upgrade your scheduling?

Join thousands of hospitality and franchise operators who save 15+ hours weekly and eliminate unbudgeted overtime completely.