API
In the "Integration" section in your personal dashboard, you can specify the url for online notification of events in your schedule.
The data is sent by a POST request in JSON format, encoding is UTF-8, with the following fields:
- ClientId - unique client number
- ClientName - client name
- ClientPhone - client phone number
- ClientEmail - client email address
- CabinetName - queue name
- CabinetSubdomain - queue subdomain
- ServiceId - unique service number, 0 for a reservation
- ServiceName - service name, empty for a reservation
- Comment - administrator comment
- BeginDateTimeLocal - start time of the service (the time the client booked) in the format yyyy-MM-ddThh:mm:ss
- DurationMinutes - total duration in minutes
- AttributesText - additional parameters in the format "name: value"
- EventType - event type. "add" - new booking, "remove" - booking deleted
- CreatedOnDateTimeUTC - date the booking was created, UTC, in the format yyyy-MM-ddThh:mm:ss
- Source - who created the booking. "themself" - self-booking, "admin" - administrator
Example of a request to add an entry by a client (self-schedule):
{
"ClientId" : 4313,
"ClientName" : "Joe",
"ClientPhone" : "79999999999",
"ClientEmail" : "test@gmail.com",
"TimetableId" : 2746133,
"CabinetName" : "Name of the room, queue",
"CabinetSubdomain" : "84703c",
"ServiceName" : "Service name",
"ServiceId" : 2143,
"Comment" : "Entry commentary",
"BeginDateTimeLocal" : "2018-04-28T12:00:00",
"CreatedOnDateTimeUtc" : "2018-04-21T09:35:48",
"DurationMinutes" : 60,
"EventType" : "add",
"Source" : "themself"
}
Example of a request for a new time reservation:
{
"ClientId" : 0,
"TimetableId" : 2746132,
"CabinetName" : "Name of the room, queue",
"CabinetSubdomain" : "84703c",
"ServiceId" : 0,
"Comment" : "Entry commentary",
"BeginDateTimeLocal" : "2018-04-27T11:00:00",
"CreatedOnDateTimeUtc" : "2018-04-21T09:22:02",
"DurationMinutes" : 60,
"EventType" : "add",
"Source" : "admin"
}
For preliminary debugging, you can use service
https://beeceptor.com
Using ssl is recommended.
The API expands based on feedback from users.