Laravel Apollo

https://github.com/jeffersongoncalves/laravel-apollo
Admin
Laravel Apollo is a PHP and Laravel client for the Apollo.io REST API, providing people and...
Tokens:1,474
Snippets:17
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Laravel Apollo via Composer

Source: https://github.com/jeffersongoncalves/laravel-apollo/blob/main/README.md

Installs the Laravel Apollo package via Composer.

```bash
composer require jeffersongoncalves/laravel-apollo
```

--------------------------------

### Organization Search and Enrichment with Apollo Facade

Source: https://github.com/jeffersongoncalves/laravel-apollo/blob/main/README.md

Shows how to search organizations with location, employee range, keyword, and page filters, and enrich an organization by domain.

```php
$organizations = Apollo::organizations()->search([
    'locations' => 'United States,Canada',
    'employee_ranges' => '1-10,11-50',
    'keywords' => 'fintech',
    'page' => 1,
]);

$organization = Apollo::organizations()->enrich('example.com');
```

--------------------------------

### People Search and Enrichment with Apollo Facade

Source: https://github.com/jeffersongoncalves/laravel-apollo/blob/main/README.md

Shows how to use the Apollo facade to search people, enrich by email/LinkedIn/name+domain, and bulk enrich by email. The search method accepts filters like titles, locations, seniorities, employee_ranges, keywords, page, and per_page.

```php
use JeffersonGoncalves\Apollo\Facades\Apollo;

// Search (supports titles, locations, seniorities, employee_ranges, keywords, page, per_page)
$people = Apollo::people()->search([
    'titles' => 'CEO,CTO',
    'locations' => 'United States,Canada',
    'seniorities' => 'founder,c_suite',
    'employee_ranges' => '1-10,11-50',
    'keywords' => 'fintech',
    'page' => 1,
]);

// Enrich by email, by LinkedIn URL, or by first name + domain
$person = Apollo::people()->enrich(['email' => 'jane@example.com']);
$person = Apollo::people()->enrich(['linkedin' => 'https://linkedin.com/in/janedoe']);
$person = Apollo::people()->enrich(['first_name' => 'Jane', 'domain' => 'example.com']);

// Bulk enrich by email
$matches = Apollo::people()->bulkEnrich(['jane@example.com', 'john@example.com']);
```

--------------------------------

### Run Package Tests

Source: https://github.com/jeffersongoncalves/laravel-apollo/blob/main/README.md

Runs the package test suite.

```bash
composer test
```

--------------------------------

### Publish Apollo Configuration File

Source: https://github.com/jeffersongoncalves/laravel-apollo/blob/main/README.md

Publishes the package configuration file (config/apollo.php) to the application.

```bash
php artisan vendor:publish --tag=apollo-config
```

--------------------------------

### Apollo Configuration File (config/apollo.php)

Source: https://github.com/jeffersongoncalves/laravel-apollo/blob/main/README.md

Configuration file for the Laravel Apollo package. Defines the API key and default per-page value, both read from environment variables.

```php
// config/apollo.php
return [
    'api_key' => env('APOLLO_API_KEY', ''),
    'default_per_page' => env('APOLLO_DEFAULT_PER_PAGE', 25),
];
```

--------------------------------

### Set Apollo API Key in .env

Source: https://github.com/jeffersongoncalves/laravel-apollo/blob/main/README.md

Sets the Apollo.io API key in the .env file. The key is found under Settings > Integrations > API in the Apollo.io account.

```env
APOLLO_API_KEY=your-api-key
```

--------------------------------

### Handle ApolloException on API Errors

Source: https://github.com/jeffersongoncalves/laravel-apollo/blob/main/README.md

Demonstrates catching ApolloException thrown on any non-2xx API response. The exception exposes the decoded error body via errorBody().

```php
use JeffersonGoncalves\Apollo\Exceptions\ApolloException;

try {
    Apollo::people()->enrich(['email' => 'unknown@example.com']);
} catch (ApolloException $e) {
    logger()->error($e->getMessage(), $e->errorBody());
}
```
Tokens:
Raw