README

A comprehensive Laravel package that provides an elegant SDK for the Multilogin API. This package allows you to manage browser profiles, automate browser sessions, handle proxies, and perform advanced browser fingerprinting operations through Multilogin's powerful antidetect browser platform.

Built on top of the robust Saloon HTTP client, this SDK provides a clean, Laravel-friendly interface to all of Multilogin's API endpoints with full type safety and IDE autocompletion.

Features

Complete API Coverage: Access all Multilogin API endpoints through intuitive resource classes
Browser Profile Management: Create, update, clone, and manage browser profiles with ease
Advanced Proxy Support: Validate and manage proxy configurations
Cookie Management: Handle pre-made cookies and import/export functionality
Two-Factor Authentication: Full 2FA management capabilities
Object Storage: Manage extensions and cloud storage objects
Script Runner: Execute Selenium automation scripts with browser profiles
Laravel Integration: Service provider, facade, and publishable config/migrations
Type Safety: Full PHP type declarations and IDE autocompletion support

Installation

You can install the package via composer:

composer require chrisreedio/laravel-multilogin-sdk

Optionally, you can publish the config file:

php artisan vendor:publish --tag="laravel-multilogin-sdk-config"

You can also publish migrations and views if needed:

# Publish migrations
php artisan vendor:publish --tag="laravel-multilogin-sdk-migrations"
php artisan migrate

# Publish views  
php artisan vendor:publish --tag="laravel-multilogin-sdk-views"

Usage

Basic Setup

use ChrisReedIO\MultiloginSDK\MultiloginSDK;

// Create SDK instance
$sdk = new MultiloginSDK();

// Or use the facade
use MultiloginSDK;

Browser Profile Management

// Start a browser profile
$response = $sdk->launcher()->startBrowserProfile(
    folderId: 'your-folder-id',
    profileId: 'your-profile-id',
    automationType: 'selenium'
);

// Create a new profile
$response = $sdk->profileManagement()->profileCreate([
    'name' => 'My New Profile',
    'browser' => 'mimic',
    'os' => 'win'
]);

// Stop a running profile
$response = $sdk->launcher()->stopBrowserProfile('your-profile-id');

Proxy Management

// Validate a proxy
$response = $sdk->launcher()->validateProxy(
    type: 'http',
    host: '127.0.0.1',
    port: '8080',
    username: 'user',
    password: 'pass'
);

Quick Profile Operations

// Start a quick profile with custom settings
$response = $sdk->launcher()->startQuickProfileV3(
    browserType: 'mimic',
    osType: 'windows',
    automation: 'selenium'
);

// Get status of all profiles
$response = $sdk->launcher()->getAllProfilesStatus();

Available Resources

The SDK provides access to all Multilogin API endpoints through these resource classes:

bookmarkManagement() - Import/export bookmarks
browserProfileData() - Manage profile data
launcher() - Core browser operations
objectStorage() - Manage extensions and cloud objects
preMadeCookies() - Handle pre-made cookie sets
profileAccessManagement() - User authentication and workspaces
profileImportExport() - Import/export profile data
profileManagement() - Create, update, manage profiles
proxy() - Proxy validation and management
scriptRunner() - Execute automation scripts
twoFactor() - Two-factor authentication

Testing

Run the test suite:

composer test

# With coverage
composer test-coverage

# Run static analysis
composer analyse

# Format code
composer format

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

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

Credits

License

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

chrisreedio / laravel-multilogin-sdk

Maintainers

Details