jobapis/jobs-jobs2careers

Making it simple to integrate your application with the Jobs2Careers API.

Jobs2Careers Job Board API Client

, _(*1)

About

This package makes it easy to connect your PHP project to the Jobs2Careers API. It uses the Jobs Common project to standardize responses using Schema.org's JobPosting specification., _(*2)

Example

Getting jobs from the API just takes a couple lines of code:, _(*3)

$query = new J2cQuery([
    'id' => YOUR_PUBLISHER_ID,
    'pass' => YOUR_PUBLISHER_PASSWORD,
    'q' => YOUR_KEYWORD_SEARCH,
    'l' => YOUR_LOCATION,
]);
$client = new J2cProvider($query);
$jobs = $client->getJobs();

See Usage section below for more detailed examples., _(*4)

Mission

JobApis makes job board and company data more accessible through open source software. To learn more, visit JobApis.com, or contact us at admin@jobapis.com., _(*5)

Requirements

• PHP 5.5+
• Composer

Installation

To install, use composer:, _(*6)

composer require jobapis/jobs-jobs2careers

Usage

Create a Query object and add all the parameters you'd like via the constructor., _(*7)

// Add parameters to the query via the constructor
$query = new JobApis\Jobs\Client\Queries\J2cQuery([
    'id' => YOUR_PUBLISHER_ID,
    'pass' => YOUR_PUBLISHER_PASSWORD,
]);

Or via the "set" method. All of the parameters documented in the documentation can be added., _(*8)

// Add parameters via the set() method
$query->set('q', 'engineering');

You can chain them if you'd like., _(*9)

// Add parameters via the set() method
$query->set('l', 'Chicago, IL')
    ->set('start', 10)
    ->set('limit', 20);

Then inject the query object into the provider., _(*10)

// Instantiating the Provider with a query object
$client = new JobApis\Jobs\Client\Providers\J2cProvider($query);

And call the "getJobs" method to retrieve results., _(*11)

// Get a Collection of Jobs
$jobs = $client->getJobs();

The getJobs() method will return a Collection of Job objects based on Schema.org's JobPosting specification., _(*12)

Testing

1. Clone this repository from Github.
2. Install the dependencies with Composer: $ composer install.
3. Run the test suite: $ ./vendor/bin/phpunit.
4. (Optional) To run all tests including actual API calls: $ ID=<YOUR PUBLISHER ID> PASS=<YOUR PUBLISHER PASSWORD> ./vendor/bin/phpunit

Contributing

Contributions are welcomed and encouraged! Please see JobApis' contribution guidelines for details, or create an issue in Github if you have any questions., _(*13)

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., _(*14)

License

This package uses the Apache 2.0 license. Please see the License File for more information., _(*15)

Copyright

Copyright 2017, Karl Hughes khughes.me@gmail.com., _(*16)