README

A Laravel package for integrating with the Apify web scraping and automation platform.

Installation

Install the package via Composer:

composer require flatroy/laravel-apify

The package will automatically register its service provider and facade.

Configuration

Publish the configuration file:

php artisan vendor:publish --tag=apify-config

Add your Apify API token to your .env file:

APIFY_API_TOKEN=your_apify_api_token_here

You can find your API token in your Apify account settings.

Usage

Using the Facade

use Apify\Laravel\Facades\Apify;

// Run an actor
$result = Apify::runActor('actor-id', [
    'url' => 'https://example.com'
], [
    'waitForFinish' => 60
]);

// Get dataset results
$data = Apify::getDataset('dataset-id');

// Get user information
$user = Apify::getUser();

Using Dependency Injection

use Apify\Laravel\ApifyClient;

class ScrapingService
{
    public function __construct(private ApifyClient $apify)
    {
    }

    public function scrapeWebsite(string $url): array
    {
        return $this->apify->runActor('web-scraper', [
            'url' => $url
        ]);
    }
}

Available Methods

Running Actors

// Run an actor and wait for completion
$result = Apify::runActor('actor-id', $input, [
    'waitForFinish' => 60, // seconds
    'memory' => 512,       // MB
]);

// Run without waiting
$result = Apify::runActor('actor-id', $input, [
    'waitForFinish' => 0
]);

Working with Datasets

// Get all items from a dataset
$items = Apify::getDataset('dataset-id');

// Get items with pagination
$items = Apify::getDataset('dataset-id', [
    'limit' => 100,
    'offset' => 200
]);

// Get specific fields only
$items = Apify::getDataset('dataset-id', [
    'fields' => ['title', 'url', 'price']
]);

Key-Value Stores

// Get a record from key-value store
$record = Apify::getKeyValueStore('store-id', 'record-key');

// Set a record in key-value store
Apify::setKeyValueStore('store-id', 'record-key', [
    'data' => 'value'
]);

// Store binary data
Apify::setKeyValueStore('store-id', 'image.jpg', $binaryData, 'image/jpeg');

Actor Runs Management

// Get actor run details
$run = Apify::getActorRun('run-id');

// Abort a running actor
$result = Apify::abortActorRun('run-id');

Listing Actors

// List all available actors
$actors = Apify::listActors();

// List only your actors
$myActors = Apify::listActors(['my' => true]);

// Paginated listing
$actors = Apify::listActors([
    'limit' => 50,
    'offset' => 100
]);

Error Handling

The package throws ApifyException for API errors:

use Apify\Laravel\ApifyException;

try {
    $result = Apify::runActor('invalid-actor-id');
} catch (ApifyException $e) {
    Log::error('Apify error: ' . $e->getMessage());
}

Configuration Options

The configuration file (config/apify.php) includes:

api_token: Your Apify API token
base_uri: API base URL (default: https://api.apify.com/v2/)
timeout: Request timeout in seconds (default: 30)
default_actor_options: Default options for running actors
webhook_url: URL for webhook notifications
webhook_events: Events to receive webhooks for

Testing

composer test

License

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

Contributing

Please see CONTRIBUTING.md for details.

Security

If you discover any security related issues, please email security@apify.com instead of using the issue tracker.

flatroy / laravel-apify

Maintainers

Details