2017 © Pedro Peláez
 

library acuityscheduling

Acuity Scheduling PHP SDK. Examples and a standard library for Acuity Scheduling integration.

image

acuityscheduling/acuityscheduling

Acuity Scheduling PHP SDK. Examples and a standard library for Acuity Scheduling integration.

  • Monday, April 10, 2017
  • by acuityscheduling
  • Repository
  • 5 Watchers
  • 6 Stars
  • 14,059 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 8 Forks
  • 0 Open issues
  • 12 Versions
  • 45 % Grown

The README.md

Acuity Scheduling API - PHP Tool Kit

Welcome to the Acuity Scheduling PHP SDK. This SDK provides examples and a standard library for integrating with the Acuity Scheduling API using PHP. You can learn more about developing for Acuity Scheduling at developers.acuityscheduling.com., (*1)

Installation

This package can be installed with composer or added to your application manually. To install with composer, first execute in a shell:, (*2)

$ composer require acuityscheduling/acuityscheduling

Then include the vendor/autoload.php in your app., (*3)

<?php
require_once('vendor/autoload.php');

If you're installing manually, simply include the AcuityScheduling.php file in your app., (*4)

Hello World

Here's a basic example to get started. Just set your API credentials and run:, (*5)

<?php
require_once('vendor/autoload.php');

$userId = null;
$apiKey = null;

$acuity = new AcuityScheduling(array(
  'userId' => $userId,
  'apiKey' => $apiKey
));

$appointments = $acuity->request('/appointments');
print_r($appointments);

Examples

You'll find several examples of different Acuity integrations in the examples/ directory. These examples cover: * Basic API Access * OAuth2 API Access * Webhooks * Custom Sidebar, (*6)

Sample examples/config.json

Create a config file with your API credentials to get started. All examples share a common config file containing your Acuity userId and apiKey for basic API access and verifying callbacks. OAuth2 examples require additional OAuth2 client account credentials., (*7)

{
    "userId": 1,
    "apiKey": "abc123"
}

Basic API Access

examples/basic/ is a basic API integration for a single account., (*8)

Start the example server by doing php -S localhost:8000 -t examples/basic and navigate to 127.0.0.1:8000, (*9)

Create an Appointment

examples/create-appointment/ is a more advanced API example for scheduling an appointment. In this example, you'll see how to:, (*10)

  • fetch appoinment types
  • find an available date and time
  • create the appointment

Start the example server by doing php -S localhost:8000 -t examples/create-appointment and navigate to 127.0.0.1:8000, (*11)

OAuth2 API Access

examples/oauth2/ is an OAuth2 API integration. Use this to get connected with multiple Acuity accounts., (*12)

Create a config file with your OAuth2 credentials to get started. If you don't have OAuth2 credentials, please fill out this registration form. Start the example server by doing php -S localhost:8000 -t examples/oauth2 and navigate to 127.0.0.1:8000, (*13)

Sample examples/config.json
{
    "clientId": "N4HgVZbjHVp3HAkR",
    "clientSecret": "H33vYz88sEiKVbl7EMob1URDrqZrvceSCMmZJpAi",
    "redirectUri": "http://127.0.0.1:8000/oauth2"
}

Webhooks

examples/webhooks/ is a sample webhook integration., (*14)

Start the example server by doing php -S localhost:8000 -t examples/webhooks and navigate to 127.0.0.1:8000, (*15)

Custom Sidebar

examples/custom-sidebar/ allows you to display custom information in the appointment details sidebar., (*16)

Start the example server by doing php -S localhost:8000 -t examples/custom-sidebar and navigate to 127.0.0.1:8000, (*17)

The Versions

10/04 2017

dev-master

9999999-dev https://github.com/AcuityScheduling/acuity-php

Acuity Scheduling PHP SDK. Examples and a standard library for Acuity Scheduling integration.

  Sources   Download

MIT

The Requires

  • php >=5.0.0
  • ext-curl *

 

The Development Requires

api oauth sdk oauth2 acuity acuity scheduling scheduling api

31/01 2017

0.1.9

0.1.9.0 https://github.com/AcuityScheduling/acuity-php

Acuity Scheduling PHP SDK. Examples and a standard library for Acuity Scheduling integration.

  Sources   Download

MIT

The Requires

  • php >=5.0.0
  • ext-curl *

 

The Development Requires

api oauth sdk oauth2 acuity acuity scheduling scheduling api

28/11 2016

0.1.8

0.1.8.0 https://github.com/AcuityScheduling/acuity-php

Acuity Scheduling PHP SDK. Examples and a standard library for Acuity Scheduling integration.

  Sources   Download

MIT

The Requires

  • php >=5.0.0
  • ext-curl *

 

The Development Requires

api oauth sdk oauth2 acuity acuity scheduling scheduling api

26/08 2016

0.1.7

0.1.7.0 https://github.com/AcuityScheduling/acuity-php

Acuity Scheduling PHP SDK. Examples and a standard library for Acuity Scheduling integration.

  Sources   Download

MIT

The Requires

  • php >=5.0.0
  • ext-curl *

 

The Development Requires

api oauth sdk oauth2 acuity acuity scheduling scheduling api

16/05 2016

0.1.6

0.1.6.0 https://github.com/AcuityScheduling/acuity-php

Acuity Scheduling PHP SDK. Examples and a standard library for Acuity Scheduling integration.

  Sources   Download

MIT

The Requires

  • php >=5.0.0
  • ext-curl *

 

The Development Requires

api oauth sdk oauth2 acuity acuity scheduling scheduling api

18/03 2016

0.1.5

0.1.5.0 https://github.com/AcuityScheduling/acuity-php

Acuity Scheduling PHP SDK. Examples and a standard library for Acuity Scheduling integration.

  Sources   Download

MIT

The Requires

  • php >=5.0.0
  • ext-curl *

 

The Development Requires

api oauth sdk oauth2 acuity acuity scheduling scheduling api

23/12 2015

0.1.4

0.1.4.0 https://github.com/AcuityScheduling/acuity-php

Acuity Scheduling PHP SDK. Examples and a standard library for Acuity Scheduling integration.

  Sources   Download

MIT

The Requires

  • php >=5.0.0
  • ext-curl *

 

api oauth sdk oauth2 acuity acuity scheduling scheduling api

21/11 2015

0.1.3

0.1.3.0 https://github.com/AcuityScheduling/acuity-php

Acuity Scheduling PHP SDK. Examples and a standard library for Acuity Scheduling integration.

  Sources   Download

MIT

The Requires

  • php >=5.0.0
  • ext-curl *

 

api oauth sdk oauth2 acuity acuity scheduling

19/08 2015

0.1.2

0.1.2.0 https://github.com/AcuityScheduling/acuity-php

Acuity Scheduling PHP SDK. Examples and a standard library for Acuity Scheduling integration.

  Sources   Download

MIT

The Requires

  • php >=5.0.0
  • ext-curl *

 

api oauth sdk oauth2 acuity acuity scheduling

19/08 2015

0.1.1

0.1.1.0 https://github.com/AcuityScheduling/acuity-php

Acuity Scheduling PHP SDK. Examples and a standard library for Acuity Scheduling integration.

  Sources   Download

MIT

The Requires

  • php >=5.0.0
  • ext-curl *

 

api oauth sdk oauth2 acuity acuity scheduling

19/08 2015

0.1.0

0.1.0.0 https://github.com/AcuityScheduling/acuity-php

Acuity Scheduling PHP SDK. Examples and a standard library for Acuity Scheduling integration.

  Sources   Download

MIT

The Requires

  • php >=5.0.0
  • ext-curl *

 

api oauth sdk oauth2 acuity acuity scheduling

19/08 2015

0.0.1

0.0.1.0 https://github.com/AcuityScheduling/acuity-php

Acuity Scheduling PHP SDK. Examples and a standard library for Acuity Scheduling integration.

  Sources   Download

MIT

The Requires

  • php >=5.0.0
  • ext-curl *

 

api oauth sdk oauth2 acuity acuity scheduling