API Documentation

function trustedStaysRequest(string $url, string $method, ?array $data = null) {
    //you may wish to consider storing this in an environment file
    $token = "zkGy4cwiTBnTqrGPaoebk8iUZskGNyIApNxiHgQa";

    $headers = array(
        "Accept: application/json",
        "Authorization: Bearer {$token}",
        'Content-Type:application/json',
    );

    $curl = curl_init();
    if($method == 'post'){
        curl_setopt($curl, CURLOPT_POST, true);
        curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($data));
    }
    curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($curl, CURLOPT_URL, $url);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($curl, CURLOPT_VERBOSE, true);

    $response = curl_exec($curl);
    if(!$response){
        error_log(curl_error($curl));
        return;
    }

    $returnedData = json_decode($response,true);

    if($returnedData['ok'] ?? false){
        //successful request
        return $returnedData;
    } else {
        //something went wrong
        error_log($returnedData['message'] ?? "No message"); // you should have a message parameter summarising the issue
        error_log(print_r($returnedData['data'] ?? null, true)); //and a data parameter providing more context
        return false;
    }

    curl_close($curl);
}
        

//whatever method is required to load the property that you want to push to TrustedStays
$yourProperty = yourGetPropertyMethod($yourPropertyId);

$createPropertyUrl = "https://www.trustedstays.co.uk/api/v1/property";

// in practice, you would populate this array from the the $yourProperty variable
$property = [
    'title' => 'Luxury apartment in the heart of Kensington',
    'status' => 'active',
    'max_guests' => 3,
    'availability_mode' => 'api',
    'price_mode' => 'api',
    'num_bedrooms' => 2,
    'beds' => [
        [
            'room_type' => 'bedroom',
            'room_number' => 1,
            'amenity_id' => 61, //double bed
        ],
        [
            'room_type' => 'bedroom',
            'room_number' => 2,
            'amenity_id' => 323, //single bed
        ],
    ]
];

$data = trustedStaysRequest($createPropertyUrl,'post',$property);
if($data){
    //the property has been successfully created
    //update your local property record with the trustedstays ID for future use
    $yourProperty->trustedstays_id = $data['data']['id'];
    $yourProperty->save();
} else {
    //handle error
}
        

// this assumes that you have already created your property on TrustedStays as above.

//whatever method is required to load the property that you want to push to TrustedStays
$yourProperty = yourGetPropertyMethod($yourPropertyId);

//build the url using the ID you saved earlier
$updatePropertyUrl = "https://www.trustedstays.co.uk/api/v1/property/".$yourProperty->trustedstays_id;

// in practice, you would populate this array from the the $yourProperty variable
$propertyUpdate = [
    'address_line1' => "1 Example Street",
    'city' => "Exampleville",
    'postcode' => "EX43PL",
    'latitude' => 51.1234567,
    'longitude' => 01.1234567,
];

$data = trustedStaysRequest($createPropertyUrl,'post',$property);

        

//whatever method is required to load the property that you want to push to TrustedStays
$yourProperty = yourGetPropertyMethod($yourPropertyId);

$calendarUrl = "https://www.trustedstays.co.uk/api/v1/calendar";

// in practice, you would populate this array from your locally stored availability and pricing data
$propertyDates = [
    properties => [
        property_id => $yourProperty->trustedstays_id,
        entries => [
            [
                "date" : "2023-11-01",
                "availability" :"available",
                "price" : 12500
            ],
            [
                "date" : "2023-11-02",
                "availability" :"unavailable",
                "price" : 12500
            ],
            [
                "date" : "2023-11-03",
                "availability" :"available",
                "price" : 14500
            ],
            // ... and so on, for at least 1 year.
        ]

    ]
];

$data = trustedStaysRequest($calendarUrl,'post',$propertyDates);

        

//whatever method is required to load your complete list of properties
$yourProperties = yourGetAllPropertyMethod();

$calendarUrl = "https://www.trustedstays.co.uk/api/v1/calendar";

$propertyDates = [];
$propertyDates['properties'] = array_map(function($property){
    return [
        property_id => $property->trustedstays_id,
        entries => [
            [
                date => date('Y-m-d', strtotime('+2 years')),
                availability => 'available',
                price => $property->yourGetPriceInPenceMethod(),
            ]
        ]
    ];
}, $yourProperties);

$data = trustedStaysRequest($calendarUrl,'post',$propertyDates);

        

protected function syncBookingFromTrustedStays($trustedStaysId) {
    $bookingUrl = "https://www.trustedstays.co.uk/api/v1/booking/".$trustedStaysId;
    $tsBooking = trustedStaysRequest($bookingUrl,'get');
    if($tsBooking){
        // collected successfully.
        // you should check your database to see if you already have $tsBooking['data']['id'].
        // if you already have this booking in your database you should update it, otherwise you can assume it is a new booking and create it
    } else {
        // request failed. Handle the error
    }
}

public function trustedStaysWebhook($request) {
    switch($request->type){
        case 'booking' :
            $this->syncBookingFromTrustedStays($request->id)
        default:
            //currently only bookings are supported
    }
}


public function syncFutureBookingsFromTrustedStays() {
    $bookingUrl = "https://www.trustedstays.co.uk/api/v1/booking?check_out_after=".date('Y-m-d');
    $tsBookings = trustedStaysRequest($bookingUrl,'get');
    if($tsBookings){
        // collected successfully.
        foreach($tsBookings as $tsBooking){
            // you should check your database to see if you already have $tsBooking['data']['id'].
            // if you already have this booking in your database you should update it, otherwise you can assume it is a new booking and create it
        }
    } else {
        // request failed. Handle the error
    }
}