The enterprise online booking API developers trust worldwide | OnSched developer hub

The OnSched Developer Hub

Welcome to the OnSched Developer Hub. Here you'll find comprehensive guides and documentation to help you start working with the OnSched API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Getting Started

OnSched is an API-First booking software solution that allows you to bring your design to life by creating your own booking flow. Using our robust API you can customize and manage the appointment scheduling workflow that works for your products and services while we do all the leg work behind the scenes.

Create your account

Sign up for a new account today by visiting https://signup.onsched.com. You will be asked for some information about your Company, once answered the following assets will be created:

  • A Company that will store your global Company settings and house all of your Locations
  • A Location that will contain all of the settings, Resources, and Services within a given location. This location will be categorized as the Primary Location, and will have the same name, domain, and address as the Company, and default business hours of Monday - Friday from 9am - 5pm.

You will arrive at the Getting Started section, which will ask that you create your first Service and Resource before enabling the "Make a test booking" button. The test booking page is created using OnSchedJs and displays an example HTML/CSS/Javascript snippet for you to configure and customize your own booking page.

Sandbox Environment

Upon registration you will be granted access to our Sandbox environment. This environment uses all of the same endpoints as Production, with a slight change to the request URI.

Two different environments allows you to build your application with all of the test data that you need, then have a clean history when in Production. You then have a space to test new features and integrations without affecting customers and data in the Production environment.

Client credentials

Once your account is created, navigate to the APISettings tab from the left hand menu. You will find the ClientId and ClientSecret in the section to the right. With your client credentials you can begin with Authentication. When you are ready to move into production you will use the same login as Sandbox. to sign in at https://dashboard.onsched.com.

Request URI

While in the Sandbox environment, all of the request urls should begin with sandbox-. The following are the request URI's for both the Consumer and Setup API Interfaces:

Sandbox
sandbox-api.onsched.com

Sandbox
api.onsched.com

Setup VS Consumer APIs

OnSched provides two API Interfaces that can be leveraged, the Setup API Interface, and Consumer API Interface. The reason for the separation is to differentiate applications based on whether or not they are consumer facing.

The Consumer API Interface focuses specifically on consumer facing online booking applications. Within this API Interface you will find GET endpoints for things like Resources, Services, and Locations. You will also find endpoints to GET availability, and POST Appointments, all of which are actions expected to be taken by the consumer in a consumer facing booking application.

The Setup API Interface contains actions surrounding internal applications such as custom on-boarding flows for your Resources, editing availability within your own application, etc. Within this API Interface you will find all of the POST endpoints you will need to create all of the Resources, Services, and Locations. In addition you'll find the endpoints you'll need to add Users to your profile.

Test in Swagger

You can try out our API right now by visiting our Swagger Docs. Click Authenticate and either use the demo credentials:

CLIENT_ID: DemoUser
CLIENT_SECRET: DemoUser

Or swap out the demo credentials for your CLIENT_ID and CLIENT_SECRET to test out the API with your own profiles data.

To toggle between the Consumer and Setup API Interfaces in our Swagger Docs, change the top right dropdown labelled "Select a definition".

Updated 2 months ago


What's Next

Authentication

Getting Started


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.