omniticket/helloasso API reference

Omniticket\HelloAsso

HelloAssoFactory class

final class HelloAssoFactory extends ProviderFactory HelloAssoFactory.php:18

HelloAsso, from its options:

client_id, client_secret the API client of the association's back office ("Intégrations et API") organization the association's slug, as in https://www.helloasso.com/associations/<slug> url https://api.helloasso.com (https://api.helloasso-sandbox.com for the sandbox)

Options

HelloAssoFactory::__construct()

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

HelloAssoProvider class

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

HelloAsso's API v5 (https://dev.helloasso.com): an association's forms of type Event are its events (GET /v5/organizations/{slug}/forms), their tiers its rates (.../forms/Event/{formSlug}/public), the items sold its tickets (.../forms/Event/{formSlug}/items), with a bearer token from POST /oauth2/token (client credentials). An event's id is its form slug.

Reading only.

HelloAssoProvider::__construct()

public function __construct(HttpClientInterface $http, readonly string $clientId, readonly string $clientSecret, readonly string $organization, readonly string $url = 'https://api.helloasso.com')

HelloAssoProvider::getName()

public function getName(): string

HelloAssoProvider::getTitle()

public function getTitle(): string

HelloAssoProvider::capabilities()

public function capabilities(): Capabilities

HelloAssoProvider::events()

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

HelloAssoProvider::event()

public function event(string $id): Event

HelloAssoProvider::attendees()

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

HelloAssoProvider::check()

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

HelloAsso has no lookup by code: the event's items are read and the code looked for among their QR codes. Its API, as read, does not say whether a ticket was scanned: a check is never "already used".