Installation steps for multi-branch practices. The process depends on how your Optomate is set up.
Single database (one virtual server, all branches)
Your Optomate lists multiple branches in one database. All staff and appointment types are shared. This is the simpler setup — the agent is installed once and covers all branches.
Multiple databases (separate server per branch)
Each branch has its own Optomate server — either a local install at each location, or separate virtual servers. Each branch shows only one branch in Optomate. An agent is installed at each location.
Not sure? Open Optomate and check how many branches are listed. If you see all your locations, it's a single database. If you only see the current branch, each location has its own database.
One Optomate database with all branches. The agent is installed once on the server (or any machine that can reach the Optomate API). One licence key covers the whole business — every branch is served by the single agent install.
YOURBOOKING (this appears as the staff code on appointments created by the booking system)| Resource | Read | Create | Update |
|---|---|---|---|
| Appointments | Yes | Yes | Yes |
| Branches | Yes | ||
| Business Details | Yes | ||
| Online Appointment Types | Yes | ||
| Optometrists | Yes | ||
| Patients | Yes | Yes | Yes |
| Sources | Yes |
For Recalls & Reminders (can be enabled later):
| Resource | Read | Create | Update |
|---|---|---|---|
| Patient Recalls | Yes | Yes | |
| Recall Types | Yes | ||
| Patient Notes | Yes | Yes |
http://localhost:12000/OptomateTouch/OData4/BranchesBecause the browser sends no login details, you'll get a short "missing credentials" error, like this:
{"error":{"code":"100","message":"Missing Credentials!"}}This is expected and confirms the API is running — you don't need to see your branch list here. If the page won't load at all ("can't connect" or it times out), the API isn't reachable: check Optomate Touch is running and the API module is installed.
| Setting | Value |
|---|---|
| Licence Key | Your licence key (provided during onboarding) |
| Optomate Server | Usually just localhost — accepts hostname, host:port, or a full URL. |
| Optomate Username | The API username from Step 1 |
| Optomate Password | The API password from Step 1 |
Open your booking page (e.g. yourbusiness.yourbooking.au) in a browser.
Each branch has its own Optomate server. An agent is installed at each location.
Repeat at every branch — same steps, same permissions as the single database setup above (Step 1, points 1-7). Each branch gets its own API credentials.
| Setting | Value |
|---|---|
| Licence Key | The licence key for this branch |
| Optomate Server | Usually just localhost — accepts hostname, host:port, or a full URL. |
| Optomate Username | The API username from Step 1 |
| Optomate Password | The API password from Step 1 |
Repeat the check below for each branch's URL (e.g. branch1.yourbooking.au, branch2.yourbooking.au, …):
If your Optomate API is accessible over the internet (e.g. hosted with IIS and a public URL), the agent install can be skipped. Your Booking connects directly to the API. Contact support to set this up.
Agents only make outbound connections. No inbound rules or port forwarding required. If outbound filtering is in place, allow:
yourbooking.au on port 443 (HTTPS/WSS)If you'd prefer, we can set up the Touch API and agent for you remotely via TeamViewer. Just let us know and we'll arrange a time.
Follow the Multi-Branch Setup Guide to configure appointment types, branding, and booking rules.
.env file in the install directory (e.g. C:\Program Files\YourBookingAgent\.env)services.msc, find "Your Booking Agent", right-click > RestartAgent logs are at logs\winsw.err.log in the install directory. Log files rotate automatically at 5MB.
The agent runs as a Windows service called YourBookingAgent. Manage it from Windows Services (services.msc) or from the command line in the install directory:
winsw start
winsw stop
winsw restart
winsw statusUse Add or Remove Programs in Windows Settings, or run the uninstaller from the Start Menu.
logs\winsw.err.log in the install directory.env file has all required valuesservices.msc.env match what you configured in Optomate's API Access settingshttp://localhost:12000/OptomateTouch/OData4/Branches in a browser on the server — a Missing Credentials! error means the API is reachable and running; if it won't connect at all, it isn'tservices.msc