jeffersongoncalves / laravel-rewardful

1.0.0 2026-09-08 00:48 UTC

Requires

• php: ^8.2
• illuminate/http: ^12.0|^13.0
• illuminate/support: ^12.0|^13.0
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• larastan/larastan: ^3.0
• laravel/pint: ^1.21
• orchestra/testbench: ^10.0|^11.0
• pestphp/pest: ^3.0|^4.0
• pestphp/pest-plugin-laravel: ^3.0|^4.0

MIT

• Jefferson Simão Gonçalves

• api
• client
• laravel
• referral
• affiliate
• rewardful

Published on Packagist.org on 2026-09-08 00:49 UTC

README

Laravel Rewardful

A Laravel client for the Rewardful affiliate and referral tracking API. A fluent Rewardful facade covers affiliates, referrals, commissions and affiliate links, authenticates every request with your API key as the HTTP Basic Auth username (empty password), and throws a RewardfulException on a non-2xx response instead of returning a silent error array.

Features

• Affiliates — listAffiliates(), getAffiliate(), searchAffiliateByEmail(), updateAffiliate()
• Referrals — listReferrals(), getReferral()
• Commissions — listCommissions(), getCommission()
• Affiliate Links — createAffiliateLink()
• Thin by design — every method returns the raw decoded JSON response as an array, no DTOs
• Fails loud — a non-2xx API response throws RewardfulException carrying the API's error message and HTTP status code

Installation

You can install the package via composer:

composer require jeffersongoncalves/laravel-rewardful

Optionally publish the config file:

php artisan vendor:publish --tag="rewardful-config"

Configuration

Add to your .env:

REWARDFUL_API_KEY=your-api-key

Find your API key in your Rewardful dashboard under Settings > API.

Config Options

// config/rewardful.php
return [
    'api_key' => env('REWARDFUL_API_KEY'),
    'base_url' => env('REWARDFUL_BASE_URL', 'https://api.getrewardful.com/v1'),
];

Usage

use JeffersonGoncalves\Rewardful\Exceptions\RewardfulException;
use JeffersonGoncalves\Rewardful\Facades\Rewardful;

Affiliates

Rewardful::listAffiliates(); // page 1
Rewardful::listAffiliates(2); // page 2

Rewardful::getAffiliate('affiliate-id');

Rewardful::searchAffiliateByEmail('[e-mail]');

Rewardful::updateAffiliate('affiliate-id', [
    'first_name' => 'Jane',
    'last_name' => 'Doe',
    'paypal_email' => '[e-mail]',
]);

Referrals

Rewardful::listReferrals(); // all referrals
Rewardful::listReferrals('affiliate-id'); // filtered by affiliate

Rewardful::getReferral('stripe-customer-id');

Commissions

Rewardful::listCommissions(); // all commissions
Rewardful::listCommissions('affiliate-id'); // filtered by affiliate

Rewardful::getCommission('commission-id');

Affiliate Links

Rewardful::createAffiliateLink('affiliate-id');
Rewardful::createAffiliateLink('affiliate-id', token: 'my-token', url: 'https://example.com');

Handling errors

try {
    $affiliate = Rewardful::getAffiliate('affiliate-id');
} catch (RewardfulException $e) {
    // $e->getMessage()  — the API's error message, or the raw response body
    // $e->statusCode    — the HTTP status code returned by Rewardful
}

Testing

composer test

Static Analysis

composer analyse

Code Formatting

composer format

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

Please review our security policy on how to report security vulnerabilities.

Credits

• Jefferson Simão Gonçalves
• All Contributors

License

The MIT License (MIT). Please see License File for more information.