Zenoti API Documentation Mirror

A documentation scraper and mirror for docs.zenoti.com, designed for offline access with Claude Code.

Overview

This repository automatically scrapes and mirrors Zenoti's API documentation, converting it to markdown format for easy reference. The scraper uses Playwright for browser automation since Zenoti's documentation is built on ReadMe.io, which renders content with JavaScript.

Features

• Automated Updates - GitHub Actions workflow refreshes documentation every 12 hours
• Three Content Types - Recipes (workflows), Guides (concepts), and API Reference
• Code Examples - Extracts Python and cURL examples from interactive tabs
• Manifest Tracking - SHA256 hashes detect content changes
• Claude Code Integration - Includes CLAUDE.md for seamless AI-assisted development

Installation

Quick Install

curl -fsSL https://raw.githubusercontent.com/tacit-code/zenoti-docs/main/install.sh | bash

Manual Install

git clone https://github.com/tacit-code/zenoti-docs.git ~/.zenoti-docs

WSL Users

If running in WSL and the install script fails with "cannot execute", use bash directly:

bash ./install.sh

Or copy manually:

cp -r /mnt/d/path/to/zenoti-docs ~/.zenoti-docs

Uninstall

~/.zenoti-docs/uninstall.sh

Usage with Claude Code

Add this to your project's CLAUDE.md:

Reference Zenoti API docs at: ~/.zenoti-docs/docs/

Key documentation:
- Booking workflow: ~/.zenoti-docs/docs/recipes/online-booking-workflow.md
- Authentication: ~/.zenoti-docs/docs/guides/authentication.md
- API Reference: ~/.zenoti-docs/docs/reference/

Documentation Structure

docs/
├── recipes/                    # Complete workflow examples with Python code
│   ├── online-booking-workflow.md
│   ├── create-opportunity.md
│   ├── sale-of-membership.md
│   ├── sale-of-package.md
│   └── ...
├── guides/                     # Conceptual documentation
│   ├── overview.md
│   ├── authentication.md
│   ├── pagination.md
│   ├── error-codes.md
│   └── ...
├── reference/                  # API endpoint documentation
│   ├── generate-access-token.md
│   ├── create-a-guest.md
│   ├── service-booking.md
│   └── ...
└── docs_manifest.json          # Tracking manifest

Running the Scraper Locally

Prerequisites

• Python 3.11+
• Playwright with Chromium

Setup

cd ~/.zenoti-docs

# Create and activate virtual environment
python3 -m venv venv
source venv/bin/activate

# Install dependencies
pip install -r scripts/requirements.txt
playwright install chromium
playwright install-deps

Run

# Activate venv if not already active
source venv/bin/activate

# Run the scraper (headless by default)
python scripts/fetch_zenoti_docs.py

# Run with visible browser for debugging
python scripts/fetch_zenoti_docs.py --visible

# Custom output directory
python scripts/fetch_zenoti_docs.py --output /path/to/docs

Interrupting Safely

The scraper uses incremental saving - each file is saved to disk immediately after scraping. This means you can safely interrupt at any time without losing progress:

• Ctrl+C once: Graceful shutdown - finishes current file, saves manifest, exits
• Ctrl+C twice: Force quit (progress up to last saved file is preserved)

The scraper will show progress like Scraped reference (42/350): endpoint-name.md so you can monitor how far along it is.

Output Location

By default, scraped files are saved relative to the script location:

Location	Path
Default	<script_parent>/docs/ (e.g., ~/.zenoti-docs/docs/)
Custom	Use --output /your/path

Listing Scraped Content

# Count files by category
find ~/.zenoti-docs/docs -name "*.md" | wc -l

# List all scraped files
find ~/.zenoti-docs/docs -name "*.md" | sort

# View manifest (tracks all files + metadata)
cat ~/.zenoti-docs/docs/docs_manifest.json

# Check scrape metadata
jq '.fetch_metadata' ~/.zenoti-docs/docs/docs_manifest.json

Verify

After scraping completes (or is interrupted), check the results:

ls ~/.zenoti-docs/docs/recipes/
ls ~/.zenoti-docs/docs/guides/
ls ~/.zenoti-docs/docs/reference/
cat ~/.zenoti-docs/docs/docs_manifest.json

Common Implementation Notes

When building Zenoti integrations, be aware of these common issues:

Issue	Solution
Two-step booking	Booking requires slot reservation then confirmation
Gender codes	Male=1, Female=2, Other=0
Guest updates	Preserve existing data when updating password
Slot reservation	Must reserve before confirming booking

GitHub Actions

The workflow runs automatically:

• Schedule: Every 12 hours (0:00 and 12:00 UTC)
• Manual: Can be triggered via workflow_dispatch

Contributing

1. Fork the repository
2. Create a feature branch
3. Submit a pull request

License

MIT

Disclaimer

This is an unofficial mirror. All documentation content is owned by Zenoti. This project is not affiliated with or endorsed by Zenoti.