README

Universal API for casino operators to access games from multiple providers through a single integration.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

Install via Composer:

composer require iplaygames/api-client-php

Manual Installation

Download the files and include autoload.php:

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

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure Bearer authorization: default
$config = IPlayGamesApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new IPlayGamesApiClient\Api\EndpointsApi(
    // 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
);
$add_a_contribution_to_a_jackpot_pool_request = new \IPlayGamesApiClient\Model\AddAContributionToAJackpotPoolRequest(); // \IPlayGamesApiClient\Model\AddAContributionToAJackpotPoolRequest

try {
    $apiInstance->addAContributionToAJackpotPool($add_a_contribution_to_a_jackpot_pool_request);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->addAContributionToAJackpotPool: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.iplaygames.ai

Class	Method	HTTP request	Description
EndpointsApi	addAContributionToAJackpotPool	POST /api/v1/jackpot/contribute	Add a contribution to a jackpot pool
EndpointsApi	addGamesToAJackpotPoolType	POST /api/v1/jackpot/games	Add games to a jackpot pool type
EndpointsApi	bulkCreateExternalGamesFromJSONArray	POST /api/v1/external-games/bulk	Bulk create external games from JSON array
EndpointsApi	bulkDeleteExternalGamesByIDs	DELETE /api/v1/external-games/bulk	Bulk delete external games by IDs
EndpointsApi	configureJackpotSettingsForTheOperator	POST /api/v1/jackpot/configure	Configure jackpot settings for the operator
EndpointsApi	configureLiveModeSettingsForAPool	PUT /api/v1/jackpot/pools/{poolId}/live-mode	Configure live mode settings for a pool
EndpointsApi	createANewPromotion	POST /api/v1/promotions	Create a new promotion
EndpointsApi	createASingleExternalGame	POST /api/v1/external-games	Create a single external game
EndpointsApi	createATargetedPlayerConfiguration	POST /api/v1/jackpot/targeted-players	Create a targeted player configuration
EndpointsApi	deactivateATargetedPlayerConfiguration	DELETE /api/v1/jackpot/targeted-players/{targetedPlayerId}	Deactivate a targeted player configuration
EndpointsApi	deleteAPromotion	DELETE /api/v1/promotions/{id}	Delete a promotion
EndpointsApi	deleteAnExternalGame	DELETE /api/v1/external-games/{id}	Delete an external game
EndpointsApi	getASingleExternalGame	GET /api/v1/external-games/{id}	Get a single external game
EndpointsApi	getASpecificPromotion	GET /api/v1/promotions/{id}	Get a specific promotion
EndpointsApi	getApiV1Producers	GET /api/v1/producers
EndpointsApi	getApiV1ProducersId	GET /api/v1/producers/{id}
EndpointsApi	getApiV1TransactionExportsExportIdDownload	GET /api/v1/transaction-exports/{export_id}/download
EndpointsApi	getCurrentConfigurationWithGames	GET /api/v1/jackpot/configuration	Get current configuration with games
EndpointsApi	getGamesForAPoolTypeOrAllPoolTypes	GET /api/v1/jackpot/games	Get games for a pool type or all pool types
EndpointsApi	getLeaderboardForAPromotion	GET /api/v1/promotions/{id}/leaderboard	Get leaderboard for a promotion
EndpointsApi	getPlayerContributionHistory	GET /api/v1/jackpot/contributions	Get player contribution history
EndpointsApi	getPoolDetails	GET /api/v1/jackpot/pools/{poolId}	Get pool details
EndpointsApi	getPoolWinners	GET /api/v1/jackpot/pools/{poolId}/winners	Get pool winners
EndpointsApi	getTargetedPlayerDetails	GET /api/v1/jackpot/targeted-players/{targetedPlayerId}	Get targeted player details
EndpointsApi	getUniqueProducerNamesForFiltering	GET /api/v1/external-games/producers	Get unique producer names for filtering
EndpointsApi	getWinnersForAPromotion	GET /api/v1/promotions/{id}/winners	Get winners for a promotion
EndpointsApi	importExternalGamesFromCSVFile	POST /api/v1/external-games/import/csv	Import external games from CSV file
EndpointsApi	importExternalGamesFromJSONPaste	POST /api/v1/external-games/import/json	Import external games from JSON paste
EndpointsApi	listExternalGamesForOperator	GET /api/v1/external-games	List external games for operator
EndpointsApi	listOperatorsJackpotPools	GET /api/v1/jackpot/pools	List operator's jackpot pools
EndpointsApi	listPromotionsForTheOperator	GET /api/v1/promotions	List promotions for the operator
EndpointsApi	listTargetedPlayersForOperator	GET /api/v1/jackpot/targeted-players	List targeted players for operator
EndpointsApi	manageGamesForAPromotion	POST /api/v1/promotions/{id}/games	Manage games for a promotion
EndpointsApi	manuallyDistributePrizesForAPeriod	POST /api/v1/promotions/{id}/periods/{periodId}/distribute	Manually distribute prizes for a period
EndpointsApi	manuallyTriggerPoolRelease	POST /api/v1/jackpot/pools/{poolId}/release	Manually trigger pool release
EndpointsApi	optInOperatorToAPlatformnetworkPromotion	POST /api/v1/promotions/{id}/opt-in	Opt-in operator to a platform/network promotion
EndpointsApi	optOutOperatorFromAPlatformnetworkPromotion	POST /api/v1/promotions/{id}/opt-out	Opt-out operator from a platform/network promotion
EndpointsApi	postApiV1GameTransactionsExport	POST /api/v1/game-transactions/export
EndpointsApi	removeGamesFromAJackpotPoolType	DELETE /api/v1/jackpot/games	Remove games from a jackpot pool type
EndpointsApi	setGrandPrizeExpirationDate	PUT /api/v1/jackpot/pools/{poolId}/expiration	Set grand prize expiration date
EndpointsApi	updateAPromotion	PUT /api/v1/promotions/{id}	Update a promotion
EndpointsApi	updateAnExternalGame	PUT /api/v1/external-games/{id}	Update an external game
FreespinsApi	cancelAStandaloneFreespin	POST /api/v1/freespins/{freespin_id}/cancel	Cancel a standalone freespin
FreespinsApi	createAStandaloneFreespin	POST /api/v1/freespins	Create a standalone freespin
GameSessionsApi	endAGameSession	POST /api/v1/game-sessions/{session_id}/end	End a game session
GameSessionsApi	getSessionStatus	GET /api/v1/game-sessions/{session_id}/status	Get session status
GameSessionsApi	startAGameSession	POST /api/v1/game-sessions/start	Start a game session
GameTransactionsApi	getTransactionDetails	GET /api/v1/game-transactions/{id}	Get transaction details
GameTransactionsApi	getTransactionHistory	GET /api/v1/game-transactions	Get transaction history
GamesApi	getApiV1GamesId	GET /api/v1/games/{id}
GamesApi	listGames	GET /api/v1/games	List games
MultiSessionsApi	endMultiSession	POST /api/v1/multi-sessions/{token}/end	End multi-session
MultiSessionsApi	getMultiSessionStatus	GET /api/v1/multi-sessions/{token}/status	Get multi-session status
MultiSessionsApi	startAMultiSession	POST /api/v1/multi-sessions/start	Start a multi-session
WidgetManagementApi	bulkRevokeTokens	POST /api/v1/widget/tokens/bulk-revoke	Bulk revoke tokens
WidgetManagementApi	generateAWidgetToken	POST /api/v1/widget/tokens	Generate a widget token
WidgetManagementApi	getDomainDetails	GET /api/v1/widget/domains/{id}	Get domain details
WidgetManagementApi	getTokenDetails	GET /api/v1/widget/tokens/{id}	Get token details
WidgetManagementApi	listRegisteredDomains	GET /api/v1/widget/domains	List registered domains
WidgetManagementApi	listWidgetTokens	GET /api/v1/widget/tokens	List widget tokens
WidgetManagementApi	regenerateDomainToken	POST /api/v1/widget/domains/{id}/regenerate-token	Regenerate domain token
WidgetManagementApi	registerANewDomain	POST /api/v1/widget/domains	Register a new domain
WidgetManagementApi	removeADomain	DELETE /api/v1/widget/domains/{id}	Remove a domain
WidgetManagementApi	revokeAToken	DELETE /api/v1/widget/tokens/{id}	Revoke a token
WidgetManagementApi	updateDomainSettings	PUT /api/v1/widget/domains/{id}	Update domain settings

Models

Authorization

Authentication schemes defined for the API:

default

Type: Bearer authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

iplaygames / api-client-php

Maintainers

Package info

Statistics

Security