Integration Overview
TymeFlow gives developers and business owners a robust toolkit to integrate SaaS booking directly into external websites, CMS environments, or custom applications. There are two primary integration models available:
1. Client Widget Embedding
Embed our beautiful, responsive booking flow iframe with one line of HTML code. Features instant slot loading, custom branding colors, and fully integrated checkout.
2. Public & Secure REST APIs
Fetch services, categories, slot options, and hold bookings programmatically via REST. Use backend endpoints to synchronize calendars and process bookings.
Credentials & Identifiers
To configure integrations, you will need key credentials from your TymeFlow Tenant Settings:
| Credential | Type | Usage |
|---|---|---|
| tenant_slug | Public String | Passed to the widget script and public endpoints to specify your shop profile (e.g., glamour-studio). |
| developer_api_key | Secret String | Passed in the X-API-Key request header for backend administration APIs. Keep this safe! |
Security Best Practice
Never expose your Developer API Key in frontend script files, client-side React files, or public git repositories. Backend requests should always be routed through your server.
Authentication
Backend API endpoints require authentication using the custom header X-API-Key.
GET /api/v1/bookings HTTP/1.1 Host: api.tymeflow.lk X-API-Key: bk_live_7a2fcf... Content-Type: application/json