Introduction

Welcome to the ResDiary API documentation.

Certification

Please note that Resdiary implements a certification process that means that use of the API must meet a minimum requirement set. We recommend that you exceed this to provide the best user experience. Please see the list of minimum requirements for the different types of integration below.

Online booking processes

• Restaurant Setup (Application Settings): Max online covers

• Restaurant Setup (Application Settings): No Availability Messaging

• All Standard Booking scenarios (including stripe-payment scenarios)

• All Promotion Booking scenarios (including stripe-payment scenarios)

Data Extraction

• Implementation of both Get Bookings and Get Booking Changes

• Use of particular Get Booking Changes can be negotiated dependent on the use of the integration.

Terminology:

• Booking Date refers to the booking created date not the date the guest is dining. Thus the result of the API call is bookings that are dining on various different dates

• Change Date refers to the date bookings are modified/edited by a user. Thus the result of the API call is changes to bookings that are dining on various different dates

Between these two API calls you have all the information to create the picture of bookings touched today. Thus we expect only 2 API calls per restaurant per day (after the initial import has been done).

See instructions on Creating and Testing a booking-guest data extraction

Data encryption

At the moment, we support TLS versions 1.0, 1.1, 1.2, and 1.3. However, we strongly recommend using TLS version 1.2 or above, because we may remove support for the older TLS versions in the future.

Requesting a token

Before you can make any further requests, you need to get an API access token. For more detailed information on requesting access tokens, refer to the documentation on OAuth 2.0 Authorization Code Flow w/ PKCE.

Making a request

Now that you've got your access token, you can use it to make a request to the API. For example, if you wanted to check whether a restaurant had availability for bookings on a certain date, you could make a call to GET api/ConsumerApi/v1/Restaurant/{micrositeName}/AvailabilitySearch/.

In order to make your call, you have to specify the Authorization header and populate it with your access token. If you don't specify your access token, or if your token has expired, the server will respond with a 401.

curl https://api.rdbranch.com/api/ConsumerApi/v1/Restaurant/ColinsNewCafe1/AvailabilitySearch ^
    -H "Authorization: Bearer VALID_TOKEN" ^
    -d VisitDate=2020-11-30 ^
    -d PartySize=2 ^
    -d ChannelCode=ONLINE

{
    "TimeSlots": [{
        "TimeSlot": "2020-11-30T07:00:00.0000000",
        "IsLeaveTimeRequired": false,
        "LeaveTime": "08:00:00",
        "ServiceId": 304,
        "HasStandardAvailability": true,
        "AvailablePromotions": [{
            "Id": 21,
            "FeeAmount": 0.0
        }, {
            "Id": 22,
            "FeeAmount": 0.0
        }],
        "StandardAvailabilityFeeAmount": 0.0
    }, {
        "TimeSlot": "2020-11-30T07:15:00.0000000",
        "IsLeaveTimeRequired": false,
        "LeaveTime": "08:15:00",
        "ServiceId": 304,
        "HasStandardAvailability": true,
        "AvailablePromotions": [{
            "Id": 21,
            "FeeAmount": 0.0
        }, {
            "Id": 22,
            "FeeAmount": 0.0
        }],
        "StandardAvailabilityFeeAmount": 0.0
    }, ...],
    "Promotions": [{
        "Id": 21,
        "Name": "Promotion 1",
        "Description": "",
        "MayRequireCreditCard": false,
        "HorizontalImageUrl": null,
        "VerticalImageUrl": null,
        "Translations": [],
        "PromotionTypeCodes": []
    }, {
        "Id": 22,
        "Name": "Promotion 2",
        "Description": "",
        "MayRequireCreditCard": false,
        "HorizontalImageUrl": null,
        "VerticalImageUrl": null,
        "Translations": [],
        "PromotionTypeCodes": []
    }],
    "StandardAvailabilityMayRequireCreditCard": false
}