Which languages are covered?

We include Python, Node.js, Go, and Rust examples for authentication, availability, holds, and confirmations.

Can I copy these examples directly?

Yes. Replace service IDs and tokens with your own values and adjust request fields as needed.

Zimun: Appointment Scheduling & Booking Software: API Usage Examples

1) Get an access token

Use OAuth2 Client Credentials to request a short‑lived token before calling any API.

import os
import requests

token_resp = requests.post(
    "https://api.zimun.online/oauth/token",
    auth=(os.getenv("ZIMUN_CLIENT_ID"), os.getenv("ZIMUN_CLIENT_SECRET")),
    data={"grant_type": "client_credentials"},
)
token = token_resp.json()["access_token"]
headers = {"Authorization": f"Bearer {token}"}

import axios from "axios";

const tokenResp = await axios.post(
  "https://api.zimun.online/oauth/token",
  new URLSearchParams({ grant_type: "client_credentials" }),
  {
    auth: {
      username: process.env.ZIMUN_CLIENT_ID,
      password: process.env.ZIMUN_CLIENT_SECRET,
    },
  }
);
const token = tokenResp.data.access_token;
const headers = { Authorization: `Bearer ${token}` };

client := &http.Client{}
req, _ := http.NewRequest("POST", "https://api.zimun.online/oauth/token", strings.NewReader("grant_type=client_credentials"))
req.SetBasicAuth(os.Getenv("ZIMUN_CLIENT_ID"), os.Getenv("ZIMUN_CLIENT_SECRET"))
req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
resp, _ := client.Do(req)
defer resp.Body.Close()

let client = reqwest::Client::new();
let resp = client
  .post("https://api.zimun.online/oauth/token")
  .basic_auth(std::env::var("ZIMUN_CLIENT_ID")?, Some(std::env::var("ZIMUN_CLIENT_SECRET")?))
  .form(&[("grant_type", "client_credentials")])
  .send()
  .await?;
let json: serde_json::Value = resp.json().await?;
let token = json["access_token"].as_str().unwrap();

2) Availability → Hold → Confirm

This is the standard booking flow. You fetch availability, place a 10‑minute hold, then confirm with customer details.

# 1) availability (holiday map / days ahead)
avail = requests.get(
    "https://api.zimun.online/api/v1/availability?service_id=s_123&days_ahead=7",
    headers=headers,
).json()

# 2) create hold
hold = requests.post(
    "https://api.zimun.online/api/v1/appointments/hold",
    headers=headers,
    json={
        "organization_id": "o_123",
        "service_id": "s_123",
        "appointment_time": "2025-12-01T10:00:00Z",
        "appointment_duration": 30,
    },
).json()

# 3) confirm
confirm = requests.post(
    "https://api.zimun.online/api/v1/appointments/confirm",
    headers=headers,
    json={
        "hold_id": hold["hold_id"],
        "contact_name": "Dana Lee",
        "contact_email": "dana@example.com",
    },
).json()

const avail = await axios.get(
  "https://api.zimun.online/api/v1/availability?service_id=s_123&days_ahead=7",
  { headers }
);

const hold = await axios.post(
  "https://api.zimun.online/api/v1/appointments/hold",
  {
    organization_id: "o_123",
    service_id: "s_123",
    appointment_time: "2025-12-01T10:00:00Z",
    appointment_duration: 30,
  },
  { headers }
);

const confirm = await axios.post(
  "https://api.zimun.online/api/v1/appointments/confirm",
  {
    hold_id: hold.data.hold_id,
    contact_name: "Dana Lee",
    contact_email: "dana@example.com",
  },
  { headers }
);

// availability
availReq, _ := http.NewRequest("GET", "https://api.zimun.online/api/v1/availability?service_id=s_123&days_ahead=7", nil)
availReq.Header.Set("Authorization", "Bearer "+token)
availResp, _ := client.Do(availReq)

// hold
holdBody := `{"organization_id":"o_123","service_id":"s_123","appointment_time":"2025-12-01T10:00:00Z","appointment_duration":30}`
holdReq, _ := http.NewRequest("POST", "https://api.zimun.online/api/v1/appointments/hold", strings.NewReader(holdBody))
holdReq.Header.Set("Authorization", "Bearer "+token)
holdReq.Header.Set("Content-Type", "application/json")
holdResp, _ := client.Do(holdReq)

let avail = client
  .get("https://api.zimun.online/api/v1/availability?service_id=s_123&days_ahead=7")
  .bearer_auth(token)
  .send()
  .await?;

let hold = client
  .post("https://api.zimun.online/api/v1/appointments/hold")
  .bearer_auth(token)
  .json(&serde_json::json!({
      "organization_id": "o_123",
      "service_id": "s_123",
      "appointment_time": "2025-12-01T10:00:00Z",
      "appointment_duration": 30
  }))
  .send()
  .await?;

3) Reschedule or cancel

Use PATCH /appointments/{appointment_id} to update the time or cancel. The customer will get the appropriate email update.

reschedule = requests.patch(
    "https://api.zimun.online/api/v1/appointments/a_123",
    headers=headers,
    json={"appointment_time": "2025-12-02T11:00:00Z"},
).json()

cancel = requests.patch(
    "https://api.zimun.online/api/v1/appointments/a_123",
    headers=headers,
    json={"status": "cancelled"},
).json()

const reschedule = await axios.patch(
  "https://api.zimun.online/api/v1/appointments/a_123",
  { appointment_time: "2025-12-02T11:00:00Z" },
  { headers }
);

const cancel = await axios.patch(
  "https://api.zimun.online/api/v1/appointments/a_123",
  { status: "cancelled" },
  { headers }
);

rescheduleBody := `{"appointment_time":"2025-12-02T11:00:00Z"}`
rescheduleReq, _ := http.NewRequest("PATCH", "https://api.zimun.online/api/v1/appointments/a_123", strings.NewReader(rescheduleBody))
rescheduleReq.Header.Set("Authorization", "Bearer "+token)
rescheduleReq.Header.Set("Content-Type", "application/json")
rescheduleResp, _ := client.Do(rescheduleReq)

cancelBody := `{"status":"cancelled"}`
cancelReq, _ := http.NewRequest("PATCH", "https://api.zimun.online/api/v1/appointments/a_123", strings.NewReader(cancelBody))
cancelReq.Header.Set("Authorization", "Bearer "+token)
cancelReq.Header.Set("Content-Type", "application/json")
cancelResp, _ := client.Do(cancelReq)

let reschedule = client
  .patch("https://api.zimun.online/api/v1/appointments/a_123")
  .bearer_auth(token)
  .json(&serde_json::json!({ "appointment_time": "2025-12-02T11:00:00Z" }))
  .send()
  .await?;

let cancel = client
  .patch("https://api.zimun.online/api/v1/appointments/a_123")
  .bearer_auth(token)
  .json(&serde_json::json!({ "status": "cancelled" }))
  .send()
  .await?;