https://github.com/jobapis/jobs-multi
Making it easy to get jobs from multiple job boards
https://github.com/jobapis/jobs-multi
api-client job-board
Last synced: 5 months ago
JSON representation
Making it easy to get jobs from multiple job boards
- Host: GitHub
- URL: https://github.com/jobapis/jobs-multi
- Owner: jobapis
- Created: 2016-09-03T15:51:31.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-17T16:28:16.000Z (over 8 years ago)
- Last Synced: 2024-10-07T04:43:40.625Z (about 1 year ago)
- Topics: api-client, job-board
- Language: PHP
- Homepage: https://www.jobapis.com/open-source/jobs-multi/
- Size: 57.6 KB
- Stars: 56
- Watchers: 12
- Forks: 21
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# [](https://www.jobapis.com) Jobs Multi
[](https://twitter.com/jobapis)
[](https://github.com/jobapis/jobs-multi/releases)
[](LICENSE.md)
[](https://travis-ci.org/jobapis/jobs-multi)
[](https://scrutinizer-ci.com/g/jobapis/jobs-multi/code-structure)
[](https://scrutinizer-ci.com/g/jobapis/jobs-multi)
[](https://packagist.org/packages/jobapis/jobs-multi)
## About
JobsMulti allows you to easily retrieve job listings from multiple job boards with one library and just a few lines of code.
Each client on its own will give you more flexibility and access to all the parameters for its respective API, but this package allows you to query one or more API in a single call. See [Usage](#usage) section below for detailed examples.
### Mission
[JobApis](https://www.jobapis.com) makes job board and company data more accessible through open source software. To learn more, visit [JobApis.com](https://www.jobapis.com), or contact us at [admin@jobapis.com](mailto:admin@jobapis.com).
## Usage
### Prerequisites
- PHP 5.5+
- [Composer PHP package manager](https://getcomposer.org/)
### Installation
Create a new directory, navigate to it, and install the Jobs Multi package with composer:
```bash
composer require jobapis/jobs-multi
```
### Configuration
Create a new file called `index.php` and open it up in your favorite text editor.
Add the [Composer autoload file](https://getcomposer.org/doc/01-basic-usage.md#autoloading) to the top of the file:
```php
[
'DeveloperKey' => '',
],
'Careercast' => [],
'Careerjet' => [
'affid' => '',
],
'Dice' => [],
'Github' => [],
'Govt' => [],
'Ieee' => [],
'Indeed' => [
'publisher' => '',
],
'Jobinventory' => [],
'J2c' => [
'id' => '',
'pass' => '',
],
'Juju' => [
'partnerid' => '',
],
'Monster' => [],
'Stackoverflow' => [],
'Usajobs' => [
'AuthorizationKey' => '',
],
'Ziprecruiter' => [
'api_key' => '',
],
];
```
### Job Collection
Next, instantiate the JobsMulti client in your `index.php` file:
```php
$client = new \JobApis\Jobs\Client\JobsMulti($providers);
```
Set the parameters for your search. These methods are documented in detail below.
```php
$client->setKeyword('training')
->setLocation('chicago, il')
->setPage(1, 10);
```
You can also create an array of `$options` that will filter your results *after* they're retrieved from the providers:
```php
$options = [
'maxAge' => 30, // Maximum age (in days) of listings
'maxResults' => 100, // Maximum number of results
'orderBy' => 'datePosted', // Field to order results by
'order' => 'desc', // Order ('asc' or 'desc')
];
```
Then you can retrieve results from each provider individually or from all providers at once:
```php
// Make queries to each individually
$indeedJobs = $client->getJobsByProvider('Indeed');
// Or get an array with results from all the providers at once
$jobs = $client->getAllJobs($options);
```
For a complete working example, see [the example folder in this repository](/example/index.php).
The `getJobsByProvider` and the `getAllJobs` method will return a [Collection](https://github.com/jobapis/jobs-common/blob/master/src/Collection.php) containing many [Job](https://github.com/jobapis/jobs-common/blob/master/src/Job.php) objects.
## Documented Methods
- `setProviders($providers)` Set an array of providers you want to use with default and required parameters for each.
- `setKeyword($keyword)` Set the search string. For example, "software engineer" or "accountant".
- `setLocation($location)` Set the location string. Should be in the format "City, ST". Currently only supports US locations. For example, "Chicago, IL" or "washington, dc".
- `setPage($pageNumber, $perPage)` Set the page number and number of results per page *for each provider*. This means that if you use the `getAllJobs()` method to retrieve your listings, you will get at most `$perPage` *times* the number of providers you choose to search.
- `setOptions($options)` Set options for get method. These options will be applied *after* all results are collected from the providers, so they function more like filters. Options include:
- `maxAge` Maximum age (in days) of listings.
- `maxResults` Truncate the results to a certain number.
- `order` Sort results by `asc` or `desc`.
- `orderBy` Field to order results by, eg: `datePosted`.
- `getAllJobs($options)` Get a collection of jobs from *all providers* configured above. See `setOptions` method above for available options.
- `getJobsByProvider($provider, $options)` Get a collection of jobs from a single provider by name. The provider must be in the array of providers. See `setOptions` method above for available options.
## Supported APIs
This package currently supports the following API providers:
- [Careerbuilder](https://github.com/jobapis/jobs-careerbuilder)
- [Careercast](https://github.com/jobapis/jobs-careercast)
- [Careerjet](https://github.com/jobapis/jobs-careerjet)
- [Dice](https://github.com/jobapis/jobs-dice)
- [Github](https://github.com/jobapis/jobs-github)
- [Govt](https://github.com/jobapis/jobs-govt)
- [IEEE](https://github.com/jobapis/jobs-ieee)
- [Indeed](https://github.com/jobapis/jobs-indeed)
- [Jobinventory](https://github.com/jobapis/jobs-jobinventory)
- [Jobs2Careers](https://github.com/jobapis/jobs-jobs2careers)
- [Juju](https://github.com/jobapis/jobs-juju)
- [Monster](https://github.com/jobapis/jobs-monster)
- [Stack Overflow](https://github.com/jobapis/jobs-stackoverflow)
- [USAJobs](https://github.com/jobapis/jobs-usajobs)
- [Ziprecruiter](https://github.com/jobapis/jobs-ziprecruiter)
If you'd like to add support for another provider, please see the [contributing section below](#contributing).
## Testing
1. Clone this repository from Github.
2. Install the dependencies with Composer: `$ composer install`.
3. Run the test suite: `$ ./vendor/bin/phpunit`.
## Contributing
Contributions are welcomed and encouraged! Please see [JobApis' contribution guidelines](https://www.jobapis.com/contributing/) for details, or create an issue in Github if you have any questions.
## Legal
### Disclaimer
This package is not affiliated with or supported by :provider_name and we are not responsible for any use or misuse of this software.
### License
This package uses the Apache 2.0 license. Please see the [License File](https://www.jobapis.com/license/) for more information.
### Copyright
Copyright 2017, Karl Hughes .