omniticket/billetweb API reference

Omniticket\Billetweb

BilletwebFactory class

final class BilletwebFactory extends ProviderFactory BilletwebFactory.php:21

Billetweb, from its options:

user the API user (Billetweb's back office, "API" - a key is read-only or read and write, possibly restricted to some events: read-only is all this package needs) key the API key timezone the zone Billetweb's dates are in (Europe/Paris): it gives local times without one currency the currency of its prices (EUR): its answers do not name it url https://www.billetweb.fr

Options

BilletwebFactory::__construct()

public function __construct(readonly ?HttpClientInterface $http = null)

BilletwebProvider class

final class BilletwebProvider implements EventCatalogInterface, AttendeeListInterface, TicketCheckInterface BilletwebProvider.php:31

Billetweb's API v1 (https://www.billetweb.fr/bo/api.php, its OpenAPI description at /api/openapi.json): GET /api/events, /api/event/{id}/avail, /api/event/{id}/tickets and /api/event/{id}/attendees, with the key in an HTTP Basic header. Reading only: nothing is written (no "check" POST, which would mark a ticket as scanned).

BilletwebProvider::__construct()

public function __construct(HttpClientInterface $http, readonly string $user, readonly string $key, readonly \DateTimeZone $timezone = new \DateTimeZone('Europe/Paris'), readonly string $currency = 'EUR', readonly string $url = 'https://www.billetweb.fr')

BilletwebProvider::getName()

public function getName(): string

BilletwebProvider::getTitle()

public function getTitle(): string

BilletwebProvider::capabilities()

public function capabilities(): Capabilities

BilletwebProvider::events()

public function events(EventQuery $query = new EventQuery()): iterable

BilletwebProvider::event()

public function event(string $id): Event

BilletwebProvider::attendees()

public function attendees(string $eventId, ?\DateTimeImmutable $updatedSince = null): iterable

BilletwebProvider::check()

public function check(string $eventId, string $code): Check