README

The HelloAsso PHP library offers a straightforward way to interact with the HelloAsso API in PHP applications. It features a collection of pre-built classes for API resources that automatically adapt to API responses, ensuring flexibility across different versions of the HelloAsso API.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

You can install the bindings via Composer. Run the following command:

composer require helloasso/helloasso-php 

To use the bindings, use Composer's autoload:

require_once 'vendor/autoload.php'; 

Manual Installation

Download the files and include autoload.php:

<?php require_once('/path/to/helloasso-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure OAuth2 access token for authorization: OAuth2 $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new OpenAPI\Client\Api\AnnuaireApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $page_size = 20; // int | The number of items per page $continuation_token = 'continuation_token_example'; // string | Continuation Token from which we wish to retrieve results $hello_asso_api_v5_models_directory_list_forms_request = new \OpenAPI\Client\Model\HelloAssoApiV5ModelsDirectoryListFormsRequest(); // \OpenAPI\Client\Model\HelloAssoApiV5ModelsDirectoryListFormsRequest | Body which contains the filters to apply try { $result = $apiInstance->directoryFormsPost($page_size, $continuation_token, $hello_asso_api_v5_models_directory_list_forms_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling AnnuaireApi->directoryFormsPost: ', $e->getMessage(), PHP_EOL; }

API Endpoints

All URIs are relative to https://api.helloasso.com/v5

Models

• HaTrustContractLegalInformationAddressAddressDto
• HelloAssoApiV5ModelsAccountCompanyLegalStatusModel
• HelloAssoApiV5ModelsAccountOrganismCategoryModel
• HelloAssoApiV5ModelsAccountsClientsApiClientModel
• HelloAssoApiV5ModelsAccountsClientsPublicPutApiClientRequest
• HelloAssoApiV5ModelsApiNotificationsApiNotificationType
• HelloAssoApiV5ModelsApiNotificationsApiUrlNotificationModel
• HelloAssoApiV5ModelsApiNotificationsPostApiUrlNotificationBody
• HelloAssoApiV5ModelsCartsCheckoutIntentResponse
• HelloAssoApiV5ModelsCartsCheckoutPayer
• HelloAssoApiV5ModelsCartsCheckoutTerm
• HelloAssoApiV5ModelsCartsInitCheckoutBody
• HelloAssoApiV5ModelsCartsInitCheckoutResponse
• HelloAssoApiV5ModelsCommonContactModel
• HelloAssoApiV5ModelsCommonDocumentModel
• HelloAssoApiV5ModelsCommonMetaModel
• HelloAssoApiV5ModelsCommonPaginationModel
• HelloAssoApiV5ModelsCommonPlaceModel
• HelloAssoApiV5ModelsDirectoryDirectoryOrganizationPublicModel
• HelloAssoApiV5ModelsDirectoryListFormsRequest
• HelloAssoApiV5ModelsDirectoryListOrganizationsRequest
• HelloAssoApiV5ModelsDirectoryPartnerOrganizationModel
• HelloAssoApiV5ModelsDirectorySynchronizableFormModel
• HelloAssoApiV5ModelsDirectorySynchronizableOrganizationModel
• HelloAssoApiV5ModelsEnumsFieldType
• HelloAssoApiV5ModelsEnumsFormState
• HelloAssoApiV5ModelsEnumsFormType
• HelloAssoApiV5ModelsEnumsItemState
• HelloAssoApiV5ModelsEnumsMembershipValidityType
• HelloAssoApiV5ModelsEnumsOperationState
• HelloAssoApiV5ModelsEnumsOrganizationType
• HelloAssoApiV5ModelsEnumsPaymentCashOutState
• HelloAssoApiV5ModelsEnumsPaymentFrequencyType
• HelloAssoApiV5ModelsEnumsPaymentMeans
• HelloAssoApiV5ModelsEnumsPaymentProviderType
• HelloAssoApiV5ModelsEnumsPaymentState
• HelloAssoApiV5ModelsEnumsPaymentType
• HelloAssoApiV5ModelsEnumsPriceCategory
• HelloAssoApiV5ModelsEnumsRecordActionType
• HelloAssoApiV5ModelsEnumsSortField
• HelloAssoApiV5ModelsEnumsSortOrder
• HelloAssoApiV5ModelsEnumsTagType
• HelloAssoApiV5ModelsEnumsTierType
• HelloAssoApiV5ModelsFormsFormBasicModel
• HelloAssoApiV5ModelsFormsFormLightModel
• HelloAssoApiV5ModelsFormsFormPublicModel
• HelloAssoApiV5ModelsFormsFormQuickCreateModel
• HelloAssoApiV5ModelsFormsFormQuickCreateRequest
• HelloAssoApiV5ModelsFormsTermModel
• HelloAssoApiV5ModelsFormsTierLightModel
• HelloAssoApiV5ModelsFormsTierPublicModel
• HelloAssoApiV5ModelsOrganizationLegalInformationsOrganizationLegalStructuresModel
• HelloAssoApiV5ModelsOrganizationLegalInformationsUpdateOrganizationFiscalReceiptTransmitterBody
• HelloAssoApiV5ModelsOrganizationLegalInformationsUpdateOrganizationLegalInformationConfigurationBody
• HelloAssoApiV5ModelsOrganizationOrganizationBasicModel
• HelloAssoApiV5ModelsOrganizationOrganizationLightModel
• HelloAssoApiV5ModelsOrganizationOrganizationModel
• HelloAssoApiV5ModelsPartnerStatisticsModel
• HelloAssoApiV5ModelsPartnersPartnerPublicModel
• HelloAssoApiV5ModelsPaymentPublicPaymentModel
• HelloAssoApiV5ModelsPaymentRefundOperationModel
• HelloAssoApiV5ModelsStatisticsItem
• HelloAssoApiV5ModelsStatisticsItemCustomField
• HelloAssoApiV5ModelsStatisticsItemDetail
• HelloAssoApiV5ModelsStatisticsItemDiscount
• HelloAssoApiV5ModelsStatisticsItemOption
• HelloAssoApiV5ModelsStatisticsItemPayment
• HelloAssoApiV5ModelsStatisticsOrder
• HelloAssoApiV5ModelsStatisticsOrderAmountModel
• HelloAssoApiV5ModelsStatisticsOrderDetail
• HelloAssoApiV5ModelsStatisticsOrderItem
• HelloAssoApiV5ModelsStatisticsOrderLight
• HelloAssoApiV5ModelsStatisticsOrderPayment
• HelloAssoApiV5ModelsStatisticsPayer
• HelloAssoApiV5ModelsStatisticsPayment
• HelloAssoApiV5ModelsStatisticsPaymentDetail
• HelloAssoApiV5ModelsStatisticsPaymentItem
• HelloAssoApiV5ModelsStatisticsRefundOperationLightModel
• HelloAssoApiV5ModelsStatisticsShareItem
• HelloAssoApiV5ModelsStatisticsSharePayment
• HelloAssoApiV5ModelsStatisticsUser
• HelloAssoApiV5ModelsTagsInternalTagModel
• HelloAssoApiV5ModelsTagsPublicTagModel
• HelloAssoCoreAccountsTaxReceiptsOrganizationFiscalReceiptOptionsConfiguration
• HelloAssoModelsAccountsOrganizationLegalInformationsFiscalReceiptSignatoryModel
• HelloAssoModelsAccountsOrganizationLegalInformationsOrganizationLegalInformationConfiguration
• HelloAssoModelsAccountsOrganizationLegalInformationsTaxInformationText
• HelloAssoModelsEnumsGlobalRole
• HelloAssoModelsPaymentsCashInFiscalReceiptFiscalReceiptFormatOption
• HelloAssoModelsSharedGeoLocation
• ResultsWithPaginationModelFormLightModel
• ResultsWithPaginationModelItem
• ResultsWithPaginationModelOrder
• ResultsWithPaginationModelPartnerOrganizationModel
• ResultsWithPaginationModelPayment
• ResultsWithPaginationModelPublicPaymentModel
• ResultsWithPaginationModelSynchronizableFormModel
• ResultsWithPaginationModelSynchronizableOrganizationModel

Authorization

We use OAuth2 for authentication, so to avoid reinventing the wheel, we recommend using the league/oauth2-client package

Prerequisite

Install the league/oauth2-client package:

composer require league/oauth2-client

Client Credentials Flow

require 'vendor/autoload.php'; use League\OAuth2\Client\Provider\GenericProvider; $provider = new GenericProvider([ 'clientId' => 'your_client_id', 'clientSecret' => 'your_client_secret', 'urlAccessToken' => 'https://api.helloasso.com/oauth2/token', 'urlAuthorize' => '', 'urlResourceOwnerDetails' => '' ]); try { // Get access token using client credentials $accessToken = $provider->getAccessToken('client_credentials'); echo 'Access Token: ' . $accessToken->getToken(); echo 'Expires in: ' . $accessToken->getExpires(); echo 'Refresh Token: ' . $accessToken->getRefreshToken(); } catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) { echo 'Error: ' . $e->getMessage(); }

Refresh Token Flow

require 'vendor/autoload.php'; use League\OAuth2\Client\Provider\GenericProvider; $provider = new GenericProvider([ 'clientId' => 'your_client_id', 'clientSecret' => 'your_client_secret', 'urlAccessToken' => 'https://api.helloasso.com/oauth2/token', 'urlAuthorize' => '', 'urlResourceOwnerDetails' => '' ]); $refreshToken = 'your_refresh_token'; try { // Refresh the access token $newAccessToken = $provider->getAccessToken('refresh_token', [ 'refresh_token' => $refreshToken, ]); echo 'New Access Token: ' . $newAccessToken->getToken(); echo 'Expires in: ' . $newAccessToken->getExpires(); echo 'New Refresh Token: ' . $accessToken->getRefreshToken(); } catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) { echo 'Error: ' . $e->getMessage(); }

Authorization Code Flow

require 'vendor/autoload.php'; use League\OAuth2\Client\Provider\GenericProvider; $provider = new GenericProvider([ 'clientId' => 'your_client_id', 'clientSecret' => 'your_client_secret', 'redirectUri' => 'https://your-app.com/callback', 'urlAuthorize' => 'https://auth.helloasso.com/authorize', 'urlAccessToken' => 'https://api.helloasso.com/oauth2/token', 'urlResourceOwnerDetails' => '' ]); // Function to generate a random code verifier function generateCodeVerifier() { return bin2hex(random_bytes(32)); } // Function to generate a code challenge from the code verifier function generateCodeChallenge($codeVerifier) { return rtrim(strtr(base64_encode(hash('sha256', $codeVerifier, true)), '+/', '-_'), '='); } // Step 1: Generate the authorization URL function GetAuthorizationUrl($provider) { $codeVerifier = generateCodeVerifier(); $codeChallenge = generateCodeChallenge($codeVerifier); $authorizationUrl = $provider->getAuthorizationUrl([ 'state' => 'random_state_string', 'code_challenge' => $codeChallenge, 'code_challenge_method' => 'S256', ]); echo 'Authorization URL: ' . $authorizationUrl . "\n"; echo 'Code verifier: ' . $codeVerifier . "\n"; } // Step 2: Handle the callback and exchange the authorization code for an access token function GetAccessTokenFromCode($provider, $authorizationCode, $codeVerifier) { try { // Get access token $accessToken = $provider->getAccessToken('authorization_code', [ 'code' => $authorizationCode, 'code_verifier' => $codeVerifier ]); echo 'Access Token: ' . $accessToken->getToken() . "\n"; echo 'Expires in: ' . $accessToken->getExpires() . "\n"; echo 'New Refresh Token: ' . $accessToken->getRefreshToken() . "\n"; } catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) { echo 'Error: ' . $e->getMessage(); } } GetAuthorizationUrl($provider); // After user authorizes, exchange the code (passed in the redirect URL callback) //GetAccessTokenFromCode($provider, 'your_authorization_code', 'your_code_verifier');

Tests

To run the tests, use:

composer install vendor/bin/phpunit

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: public
  • Generator version: 7.10.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen