# Dentally NexGen API

Welcome to the **NexGen API** reference. This site is generated from the OpenAPI contract and is intended for **integration testing and exploration** before the API is generally available.

## Overview

The NexGen API exposes HTTP resources for partner integrations with Dentally. The machine-readable contract defines paths, request and response shapes, parameters, and security expectations.

|  |  |
|  --- | --- |
| **API title** | Dentally NexGen API |
| **Contract version** | `2026-01-01` (see `info.version` in the OpenAPI document) |
| **Specification** | OpenAPI 3.0 |


Use the **API reference** section in this documentation portal to browse operations, try examples, and download the full specification if your tooling supports it.

## Environments

The OpenAPI `servers` entry describes the base URL for each environment. Point your client at the appropriate **server URL** and prefix paths as defined in the spec (for example `/v2` where applicable).

For **local development**, the contract may list a localhost base URL. **Production** URLs will be provided when integrations go live.

## Authentication

Operations declare **`bearerAuth`**: send credentials using the `Authorization` header with the `Bearer` scheme unless your project documentation specifies otherwise.

Some requests require additional headers (for example practice scoping). Refer to each operation’s parameters in the reference.

## Resources in this contract

The specification is organised by **tags**. Current groups include:

- **Sites** — Practice locations: addresses, contact details, and opening hours. **Reference examples and mock responses** in this contract focus on Sites.
- **Patients** — Present for early experimentation; this surface is expected to be **redesigned**—do not treat it as stable for integrations.


New resources will appear here as the contract grows.

## Support

For product and integration questions, use the contact details in the OpenAPI `info.contact` block (Synapse Team, Dentally).

## Testing notice

This documentation site is for **testing only**. Behaviour, URLs, authentication, and availability may change without notice. Do not rely on this deployment for production traffic or contractual SLAs.