PHPackages propellocloud/propello-php-sdk - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. propellocloud/propello-php-sdk ActiveLibrary[API Development](/categories/api) propellocloud/propello-php-sdk ============================== PHP SDK for easy integration with Propello Clouds API V3 1.1.1(1mo ago)03[4 PRs](https://github.com/PropelloCloud/propello-php-sdk/pulls)MITPHPPHP ^8.3|^8.4CI passing Since Apr 10Pushed 1mo ago1 watchersCompare [ Source](https://github.com/PropelloCloud/propello-php-sdk)[ Packagist](https://packagist.org/packages/propellocloud/propello-php-sdk)[ Docs](https://github.com/propellocloud/propello-php-sdk)[ GitHub Sponsors](https://github.com/PropelloCloud)[ RSS](/packages/propellocloud-propello-php-sdk/feed)WikiDiscussions main Synced 1w ago READMEChangelog (4)Dependencies (8)Versions (10)Used By (0) Propello Cloud PHP SDK - API V3 =============================== [](#propello-cloud-php-sdk---api-v3) [![Latest Version on Packagist](https://camo.githubusercontent.com/2aeb5ab735c75b82561a2561695bc541d0296c15af10339e7013bbf8ddd9f304/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f70726f70656c6c6f636c6f75642f70726f70656c6c6f2d7068702d73646b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/propellocloud/propello-php-sdk) This package is intended to allow clients to integrate with the Propello Cloud API with minimal intervention. Requirements ------------ [](#requirements) - PHP: 8.3+ Installation ------------ [](#installation) You can install the package via composer: ``` composer require propellocloud/propello-php-sdk ``` Currently, all of Propello Clouds V3 User endpoints have been implemented in this SDK. This functionality will be expanded as the API is further developed, as such you should aim to make use of the latest version at all times. Authentication -------------- [](#authentication) In order to connect to the API you will first need to authenticate your instance with either a `Bearer Token`or a `Client Secret` and `Client ID`. ``` use PropelloCloud\Client; // with Bearer Token $client = new Client(bearerToken: $bearerToken); // with client secret & ID $client = new Client(clientId: $clientId, clientSecret: $clientSecret); ``` ##### NOTE: It is highly recommended that you implement the bearer token method as this requires fewer calls to the API and is far less data intensive. [](#note-it-is-highly-recommended-that-you-implement-the-bearer-token-method-as-this-requires-fewer-calls-to-the-api-and-is-far-less-data-intensive) ##### Bearer tokens are valid for 1 year and can be obtained as follows: [](#bearer-tokens-are-valid-for-1-year-and-can-be-obtained-as-follows) ``` use PropelloCloud\Client; $client = new Client(clientId: $clientId, clientSecret: $clientSecret); $bearerToken = $client->getBearerToken(); ``` Security -------- [](#security) Propello cloud does not bear any liability or responsibility for the security of your API credentials; as such it is vital that you take all possible steps to prevent unauthorised access. Usage ----- [](#usage) The below are all currently available methods: ``` use PropelloCloud\Client; $client = new Client(bearerToken: $bearerToken); // Creates a user $client->user->create(array $user); // Create multiple users (max 100) $client->user->createBulk(array $users, bool $sendEmails) // Creates a user and returns user one-time login URL $client->user->createUserWithLogin(array $user); // Returns a users details $client->user->getUserByEmail(string $email); $client->user->getUserByUid(string $uniqueId); $client->user->getUserById(int $id); // Returns a user one-time login URL $client->user->getLoginByEmail(string $email); $client->user->getLoginByUid(string $uniqueId); $client->user->getLoginById(int $id); // Deletes a user $client->user->deleteByEmail(string $email); $client->user->deleteByUid(string $uniqueId); $client->user->deleteById(int $id); // Restores a deleted user $client->user->restoreByEmail(string $email); $client->user->restoreByUid(string $uniqueId); $client->user->restoreById(int $id); // Anonymises a users details $client->user->anonymiseByEmail(string $email); $client->user->anonymiseByUid(string $uniqueId); $client->user->anonymiseById(int $id); // Restore anonymised user account with details $client->user->makeKnownByUid(string $uniqueId, array $userDetails); $client->user->makeKnownById(int $id, array $userDetails); // Returns a paginated list of users $client->user->list(array $filters); // Returns redemption stats for a user $client->user->getRedemptionStatsByEmail(string $email); $client->user->getRedemptionStatsByUid(string $uniqueId); $client->user->getRedemptionStatsById(int $id); ``` ### Groups [](#groups) ``` use PropelloCloud\Client; $client = new Client(bearerToken: $bearerToken); // Returns the current organisation group $client->group->get(); // If your token has organisation or global access, pass the group ID explicitly $client->group->get(int $organisationGroupId); // Returns all organisation groups (requires organisation-level access) $client->group->list(); ``` ### Orders [](#orders) ``` use PropelloCloud\Client; $client = new Client(bearerToken: $bearerToken); // Returns a paginated list of all orders for the group $client->orders->listGroupOrders(array $filters); // Available filters: per_page, page, order_created_from, order_created_to, order_status, brand_id, brand_name, organisation_group_id // Returns orders for a specific user $client->orders->listUserOrdersByEmail(string $email, array $filters); $client->orders->listUserOrdersByUid(string $uniqueId, array $filters); $client->orders->listUserOrdersById(int $id, array $filters); ``` ### Offers [](#offers) ``` use PropelloCloud\Client; $client = new Client(bearerToken: $bearerToken); // Returns a list of offers $client->offers->list(); // If your token has organisation or global access, pass the group ID explicitly $client->offers->list(int $organisationGroupId); // Returns a single offer by ID $client->offers->get(int $id); $client->offers->get(int $id, int $organisationGroupId); ``` ### Interactions [](#interactions) ``` use PropelloCloud\Client; $client = new Client(bearerToken: $bearerToken); // Returns a list of interactions for a specific user $client->interactions->listByEmail(string $email, array $filters); $client->interactions->listByUid(string $uniqueId, array $filters); $client->interactions->listById(int $id, array $filters); // Stores an interaction for a specific user $client->interactions->storeByEmail(string $email, array $interaction); $client->interactions->storeByUid(string $uniqueId, array $interaction); $client->interactions->storeById(int $id, array $interaction); ``` Credits ------- [](#credits) - [Richard Porter](https://github.com/rpwebdevelopment) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 45 — FairBetter than 91% of packages Maintenance91 Actively maintained with recent releases Popularity3 Limited adoption so far Community20 Small or concentrated contributor base Maturity61 Established project with proven stability Bus Factor3 3 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~149 days Total 4 Last Release 47d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/185902761?v=4)[PropelloCloud](/maintainers/PropelloCloud)[@PropelloCloud](https://github.com/PropelloCloud) --- Top Contributors [![freekmurze](https://avatars.githubusercontent.com/u/483853?v=4)](https://github.com/freekmurze "freekmurze (116 commits)")[![mvdnbrk](https://avatars.githubusercontent.com/u/802681?v=4)](https://github.com/mvdnbrk "mvdnbrk (29 commits)")[![Nielsvanpach](https://avatars.githubusercontent.com/u/10651054?v=4)](https://github.com/Nielsvanpach "Nielsvanpach (26 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (24 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (19 commits)")[![brendt](https://avatars.githubusercontent.com/u/6905297?v=4)](https://github.com/brendt "brendt (13 commits)")[![pforret](https://avatars.githubusercontent.com/u/474312?v=4)](https://github.com/pforret "pforret (9 commits)")[![riasvdv](https://avatars.githubusercontent.com/u/3626559?v=4)](https://github.com/riasvdv "riasvdv (8 commits)")[![AdrianMrn](https://avatars.githubusercontent.com/u/12762044?v=4)](https://github.com/AdrianMrn "AdrianMrn (7 commits)")[![PropelloCloud](https://avatars.githubusercontent.com/u/185902761?v=4)](https://github.com/PropelloCloud "PropelloCloud (5 commits)")[![thecaliskan](https://avatars.githubusercontent.com/u/13554944?v=4)](https://github.com/thecaliskan "thecaliskan (4 commits)")[![gregkos](https://avatars.githubusercontent.com/u/6676236?v=4)](https://github.com/gregkos "gregkos (4 commits)")[![rpwebdevelopment](https://avatars.githubusercontent.com/u/15613749?v=4)](https://github.com/rpwebdevelopment "rpwebdevelopment (3 commits)")[![patinthehat](https://avatars.githubusercontent.com/u/5508707?v=4)](https://github.com/patinthehat "patinthehat (3 commits)")[![koossaayy](https://avatars.githubusercontent.com/u/6431084?v=4)](https://github.com/koossaayy "koossaayy (2 commits)")[![jamessessford](https://avatars.githubusercontent.com/u/17096446?v=4)](https://github.com/jamessessford "jamessessford (2 commits)")[![irfanm96](https://avatars.githubusercontent.com/u/42065936?v=4)](https://github.com/irfanm96 "irfanm96 (2 commits)")[![adevade](https://avatars.githubusercontent.com/u/1066486?v=4)](https://github.com/adevade "adevade (2 commits)")[![erikn69](https://avatars.githubusercontent.com/u/4933954?v=4)](https://github.com/erikn69 "erikn69 (2 commits)")[![weerd](https://avatars.githubusercontent.com/u/105849?v=4)](https://github.com/weerd "weerd (1 commits)") --- Tags PropelloCloudpropello-php-sdk ### Code Quality TestsPHPUnit Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/propellocloud-propello-php-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/propellocloud-propello-php-sdk/health.svg)](https://phpackages.com/packages/propellocloud-propello-php-sdk) ``` ### Alternatives [tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3661.3M49](/packages/tencentcloud-tencentcloud-sdk-php)[eslazarev/wildberries-sdk Wildberries OpenAPI clients (generated). 353.6k](/packages/eslazarev-wildberries-sdk)[neuron-core/neuron-ai The PHP Agentic Framework. 2.0k832.6k55](/packages/neuron-core-neuron-ai)[files.com/files-php-sdk Files.com PHP SDK 2482.9k](/packages/filescom-files-php-sdk)[volcengine/volcengine-php-sdk 119.5k](/packages/volcengine-volcengine-php-sdk) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)