assisjeferson/seatsio-php

A PHP client for the seats.io API

seatsio-php, the official Seats.io PHP client library

, _(*1)

This is the official PHP client library for the Seats.io V2 REST API., _(*2)

Installing seatsio-php

The recommended way to install seatsio-php is through Composer., _(*3)

composer require seatsio/seatsio-php

The minimum required PHP version is 5.5., _(*4)

Versioning

seatsio-php only uses major version numbers: v5, v6, v7 etc. Each release - backwards compatible or not - receives a new major version number., _(*5)

The reason: we want to play safe and assume that each release might break backwards compatibility., _(*6)

Examples

Creating a chart and an event

$seatsio = new \Seatsio\SeatsioClient(<SECRET KEY>); // can be found on https://app.seats.io/settings
$chart = $seatsio->charts->create();
$event = $seatsio->events->create($chart->key);
echo 'Created event with key ' . $event->key;

Booking objects

Changes the object status to ‘booked’. Booked seats are not selectable on a rendered chart., _(*7)

https://www.seats.io/docs/api-v2#core-resources-objects-book-objects, _(*8)

$seatsio = new \Seatsio\SeatsioClient(<SECRET KEY>);
$seatsio->events->book(<AN EVENT KEY>, ["A-1", "A-2"]);

Booking objects that have been held

$seatsio = new \Seatsio\SeatsioClient(<SECRET KEY>);
$seatsio->events->book(<AN EVENT KEY>, ["A-1", "A-2"], <A HOLD TOKEN>);

Booking general admission areas

Either, _(*9)

$seatsio = new \Seatsio\SeatsioClient(<SECRET KEY>);
$seatsio->events->book(<AN EVENT KEY>, ["GA1", "GA1", "GA1"]);

Or, _(*10)

$seatsio = new \Seatsio\SeatsioClient(<SECRET KEY>);
$seatsio->events->book(<AN EVENT KEY>, ["objectId" => "GA1", "quantity" => 3]);

Releasing objects

Changes the object status to ‘free’. Free seats are selectable on a rendered chart., _(*11)

https://www.seats.io/docs/api-v2#core-resources-objects-release-objects, _(*12)

$seatsio = new \Seatsio\SeatsioClient(<SECRET KEY>);
$seatsio->events->release(<AN EVENT KEY>, ["A-1", "A-2"]);

Changing object status

Changes the object status to a custom status of your choice. If you need more statuses than just booked and free, you can use this to change the status of a seat, table or booth to your own custom status., _(*13)

https://www.seats.io/docs/api-v2#core-resources-objects-change-object-status, _(*14)

$seatsio = new \Seatsio\SeatsioClient(<SECRET KEY>);
$seatsio->events->changeObjectStatus(<AN EVENT KEY>, ["A-1", "A-2"], "unavailable");

Event reports

Want to know which seats of an event are booked, and which ones are free? That’s where reporting comes in handy., _(*15)

The report types you can choose from are: - byStatus - byCategoryLabel - byCategoryKey - byLabel - byOrderId, _(*16)

https://www.seats.io/docs/api-v2#core-resources-event-reports, _(*17)

$seatsio = new \Seatsio\SeatsioClient(<SECRET KEY>);
$seatsio->eventReports->byStatus(<AN EVENT KEY>, <OPTIONAL FILTER>);

Listing charts

$seatsio = new \Seatsio\SeatsioClient(<SECRET KEY>);

$chart1 = $seatsio->charts->create();
$chart2 = $seatsio->charts->create();
$chart3 = $seatsio->charts->create();

$charts = $seatsio->charts->listAll();
foreach($charts as $chart) {
    echo 'Chart ' . $chart->key;
}

Error handling

When an API call results in a 4xx or 5xx error (e.g. when a chart could not be found), a SeatsioException is thrown., _(*18)

This exception contains a message string describing what went wrong, and also two other properties:, _(*19)

• messages: an array of error messages that the server returned. In most cases, this array will contain only one element.
• requestId: the identifier of the request you made. Please mention this to us when you have questions, as it will make debugging easier.