Download the PHP package gonebusy/gonebusy-php-client without Composer

PHP SDK for the Gonebusy REST API

Sandbox

We have a Sandbox environment to play with!

To point at the Sandbox, just use sandbox.gonebusy.com instead of where you see beta.gonebusy.com referenced, including where to create an account to retrieve your API Key.

The Sandbox environment is completely separate from the Live site - that includes meaning your Sandbox API Key will not work in the Live environment.

How to Use

Summary of Gonebusy objects

(more info on the Developer Portal):

• A User is required to perform operations.
• A Resource (WHO) performs Services and is needed for all scheduling operations. Each User is assigned a default Resource (her/himself) automatically.
• A Service (WHAT) is performed by Resources according to a Schedule. Services are assigned a Pricing Model. Services can be assigned a Category as well.
• A Schedule (WHEN) defines when a Service is performed by a Resource. Pieces of a Schedule are called Time Windows.
• Finally, a Booking is placed (at a particular Time Window) in a Schedule, linking it to a Resource-Service combo.
• A Search of users and services can be performed.

API Key

If testing with Sandbox, Signup/Logon at https://sandbox.gonebusy.com/login.

If using Production site, Signup/Logon at https://beta.gonebusy.com/login.

Once logged in, navigate to the API Key page and request an API key.

Initialization/Authentication

In order to setup authentication and initialization of the API client, you need the following information.

API client can be initialized as following.

How to Build

Composer Install

[For Windows Users Only] Configuring CURL Certificate Path in php.ini

CURL used to include a list of accepted CAs, but no longer bundles ANY CA certs. So by default it will reject all SSL certificates as unverifiable. You will have to get your CA's cert and point curl at it. The steps are as follows:

1. Download the certificate bundle (.pem file) from https://curl.haxx.se/docs/caextract.html on to your system.
2. Add curl.cainfo = "PATH_TO/cacert.pem" to your php.ini file located in your php installation. “PATH_TO” must be an absolute path containing the .pem file.

How to Test

Unit tests in this SDK can be run using PHPUnit. The test cases are located in the test/Controllers/ dir.

1. Make sure you've installed the dependencies using composer including the require-dev dependencies.
2. Run vendor/bin/phpunit from command line to execute the test suite. See https://phpunit.de/manual/current/en/textui.html for info on test output format as well as more command-line options.
3. Optionally, to check the code standards you may run vendor/bin/phpcs (See phpcs.xml). (No output means no problems.)

Class Reference

List of Controllers

• BookingsController
• CategoriesController
• PricingModelsController
• ResourcesController
• SchedulesController
• SearchController
• ServicesController
• UsersController

BookingsController

Get singleton instance

The singleton instance of the class can be accessed from the API Client.

getBookings

Return list of Bookings.

Parameters

Example Usage

Errors

createBooking

Create a Booking with params

Parameters

Example Usage

Errors

getBookingById

Return a Booking by id.

Parameters

Example Usage

Errors

updateBookingById

Update a Booking by id

Parameters

Example Usage

php function cancelBookingById( $authorization, $id, $cancelRecurring = null, $date = null, $endDate = null) Required Required Optional Optional Optional CategoriesController Required Optional DefaultValue Optional DefaultValue Optional Required Optional Required Required PricingModelsController Required Optional DefaultValue Optional DefaultValue Optional Required Optional Required Required Required Required Optional ResourcesController Required Optional DefaultValue Optional DefaultValue Optional Required Optional Required Optional DefaultValue Optional DefaultValue Required Required Required Required Optional Required Required SchedulesController Required Optional DefaultValue Optional DefaultValue Optional Required Optional Required Required Required Required Required Required Optional Required Required Required Optional Required Required Required SearchController Required Required ServicesController Required Optional DefaultValue Optional ``` DefaultValue | Number of results to return per page. | | userId | Optional | Retrieve Services provided by the User specified by Id. You must be authorized to manage this User Id. |

Example Usage

Errors

createService

Create a Service with params.

Parameters

Example Usage

Errors

getServiceAvailableSlotsById

Return available times for a Service.

Parameters

Example Usage

Errors

getServiceById

Return a Service by id.

Parameters

Example Usage

Errors

updateServiceById

Update a Service with params.

Parameters

Example Usage

Errors

deleteServiceById

Delete a Service by id

Parameters

Example Usage

Errors

Back to List of Controllers

UsersController

Get singleton instance

The singleton instance of the UsersController class can be accessed from the API Client.

getUsers

Return all Users that your account has access to. Includes your own User as well as any Users for which you are the Account Manager.

Parameters

Example Usage

Errors

createUser

Create a User

Parameters

Example Usage

Errors

getUserById

Return a User by id.

Parameters

Example Usage

Errors

updateUserById

Update a User by id, with params.

Parameters

Example Usage

Errors

Back to List of Controllers