Getting Started

This guide will help you get started with the Public API.

Prerequisites

Before you begin, make sure you have:

  • A valid tenant ID
  • API credentials (client ID and client secret)
  • Basic understanding of REST APIs and HTTP requests

Step 1: Obtain an Access Token

First, you need to authenticate and obtain an access token:

POST /{tenantId}/authentication/token
Content-Type: application/json

{
  "clientId": "your-client-id",
  "clientSecret": "your-client-secret"
}

The response will contain an access token that you'll use for subsequent API calls.

Step 2: Make Your First API Call

Once you have an access token, you can start making authenticated requests:

GET /{tenantId}/appointment?appointmentId=123
Authorization: Bearer {access-token}
tenantId: {your-tenant-id}

Headers

All authenticated requests require the following headers:

  • Authorization: Bearer {access-token}
  • tenantId: {your-tenant-id} (in addition to the tenantId in the URL path)

Next Steps