The ClickBook.net SOAP WebService API
provides comprehensive access to the ClickBook engine for custom user interfaces and bespoke workflow integration with Local Business Directories
), providing them with the prospect of real-time availability display and confirmed appointment booking, detail management and appointment reminder services for their customers.
Developers are requested to contact ClickBook before using this Interface. The API contains performance and function limitations unless used with an authorised API Key.
The Public and Private APIs are designed to work transitionally through the Admin API (not documented here). The Admin API bridges the process flow between Anonymous (Public API) and Authentcated (Private API) functionality. In practical terms, this means that an interface can implement the selection of Service Provider, Location, Service and Timeslot, then interact with the Admin API to register new users and submit authenticated booking requests to the Private API, in a single process flow.
API SandBox Guide
This SandBox is an isolated environment that allows authorised partners to build and test their interface without using live data. This guide contains critical information to get started, including full examples. For access to the SandBox please contact us.
Private API (Auth)
The Private API operations can only be accessed by authenticated users. ClickBook defines 3 user types:
- Service Provider Authority (Main Contact)
- Service Provider Staff / Resource
- Service Provider Customer
The purpose of the Private API is to facilitate third-party interfaces to end-user functions. Due to the HTTP session authentication requirement, such interfaces must facilitate username / password entry by the end-user and should never store or cache this information in any way.
The Private API is used by ClickBook Mobile and the ClickBook Scheduler Widget.