Open Dental
Open Dental Software, Inc.
Open Dental
REST API adapter for Open Dental practice management software. No OAuth, no FHIR — uses two static keys (Developer Key + Customer Key) via a custom Authorization header. BYOK (bring-your-own-key): ConnectHealth does not issue or hold these keys — each clinic obtains its own Developer Key and Customer Key directly from Open Dental (vendor.relations@opendental.com) and supplies both when creating the connection.
Overview
ConnectHealth's Open Dental integration lets your application connect to Open Dental's Remote API using your own Developer Key and Customer Key. Open Dental uses a custom REST API — not OAuth, not FHIR — so there is no authorization redirect and no token to refresh. ConnectHealth verifies your key pair against the live Remote API when you test the connection.
ConnectHealth does not issue or hold an Open Dental vendor credential on your behalf. You obtain your own Developer Key and Customer Key directly from Open Dental — the same process any independent developer follows — and paste both into ConnectHealth's Add Connection form. Your relationship (and any associated billing) with Open Dental stays directly between your practice and Open Dental.
On This Page
Supported Authentication Flows
Key Features
- Single fixed Remote API endpoint — no per-clinic base URL to configure
- No OAuth flow — simpler setup than Epic, Elation, or Cerner
- Live connection test against Open Dental's Remote API before you save the connection
- Automatic retry with exponential backoff on rate limiting (HTTP 429)
- Audit logging for all operations
Before You Begin
Open Dental's API is opt-in per developer and per office. Before you can connect, you need your own Developer Key from Open Dental and a Customer Key generated and enabled for your specific office.
Prerequisites Checklist
- Applied to Open Dental as your own API developer/vendor — Email vendor.relations@opendental.com with your company info and wait for approval
- Developer Key issued — Provided by Open Dental once your vendor application is approved
- Customer Key generated — Created in your own Open Dental Developer Portal account, for your own office
- Customer Key added to your Open Dental install — Pasted into Setup > Advanced Setup > API > Add Key, and enabled
- eConnector running and API access enabled — Your Open Dental install must have its eConnector service running for the Remote API to reach your office data
Get Your Developer Key & Customer Key
Both keys come directly from Open Dental — ConnectHealth is never in this loop, and never sees or stores a shared credential on your behalf.
Apply as an Open Dental Developer
Email vendor.relations@opendental.com with your company information. Open Dental reviews and approves API developer/vendor applications individually.
Receive Your Developer Key
Once approved, Open Dental issues you a Developer Key. This key identifies your application to Open Dental across every office you connect.
Generate a Customer Key
In your Open Dental Developer Portal account, generate a Customer Key for your own office.
Store your Developer Key and Customer Key securely and never expose them in client-side code. Together they grant full API access to the connected office's Open Dental data.
Enable the Key in Your Open Dental Install
In your Open Dental software: Setup > Advanced Setup > API > Add Key. Paste the Customer Key and enable it. Confirm the eConnector service is running.
Add the Connection in ConnectHealth
Go to Integrations > Add Connection > Open Dental, enter both keys, and click Test Connection to confirm they authenticate against Open Dental's Remote API.
Remote API Endpoint
Open Dental offers three API modes — Local, Service, and Remote. Remote is the only mode reachable by a cloud-hosted platform like ConnectHealth, and it uses a single fixed, public endpoint shared by every clinic. There is no per-clinic base URL to configure — ConnectHealth pre-fills it for you.
| API Mode | Reachable From | Used by ConnectHealth |
|---|---|---|
| Local | Same workstation only (port 30222) | No |
| Service | On-premise network only (port 30223) | No |
| Remote | https://api.opendental.com/api/v1 (public, fixed) |
Yes |
Open Dental documents 1 request/second for most endpoints (1 request/5 seconds for full-table reads). ConnectHealth automatically retries HTTP 429 responses with exponential backoff.
Configuration
Open Dental only supports the BYOK dual-key flow. There is no OAuth setup, no redirect URI, and no JWKS endpoint. Enter your keys in ConnectHealth's Add Connection form.
Unlike Epic or Cerner, Open Dental does not require OAuth setup, redirect URIs, or token refresh. Once both keys are entered and verified, the connection is ready to use.
Connection Fields
| Field | Required | Description |
|---|---|---|
| Developer Key | Yes | Issued to you by Open Dental after vendor approval. |
| Customer Key | Yes | Generated in your own Open Dental Developer Portal account, for your own office. |
| API Base URL | N/A | Read-only, pre-filled with https://api.opendental.com/api/v1 — the same for every connection. |
Current Capabilities
Today, the Open Dental integration covers connecting and verifying access:
- Add a connection — enter your Developer Key and Customer Key
- Test the connection — ConnectHealth calls a non-PHI reference endpoint on Open Dental's Remote API to confirm your keys authenticate correctly
Endpoints for retrieving or writing patient and appointment data are not exposed yet. Open Dental also has no webhook support — any future data access will be polling-based. This page will be updated when that capability ships.
External Resources
- Open Dental API Setup — How to apply for developer/vendor access
- Open Dental API Implementation — Official Open Dental REST API reference
- Open Dental API Modes — Local, Service, and Remote API details
- Open Dental Developer Portal — Generate and manage your Customer Key