README

Introduction

This documentation provides a detailed overview of the PoleEmploi Laravel Library, a PHP package for Laravel applications. It allows seamless integration with the French government's Pôle Emploi API to access extensive data on professions in France.

Requirements

PHP 7.4 or higher
Laravel 6.0 or higher

Installation:

To install the Laravel Pôle Emploi API library, run the following command:

composer require ogrre/laravel-pole-emploi

After the installation, publish the vendor files by executing the command:

php artisan vendor:publish --provider="Ogrre\\PoleEmploi\\PoleEmploiServiceProvider"

By default, the service provider will be automatically registered in the app.php file. However, if needed, you can manually add the service provider in the config/app.php file:

# config/app.php

'providers' => [
    // ...
    Ogrre\PoleEmploi\PoleEmploiServiceProvider::class,
];

Usage

The library provides various classes to interact with different aspects of the Pôle Emploi API.

PoleEmploi Client

Responsible for authenticating and communicating with the API.

use Namespace\Path\PoleEmploiClient;

$client = new PoleEmploiClient(/* configuration parameters */);

Metier (Profession)

Retrieves information about different professions.

use Namespace\Path\Metier;

$metier = new Metier($client);
$professionData = $metier->getProfessionInfo(/* parameters */);

Competence (Skill)

Handles data related to skills associated with various professions.

use Namespace\Path\Competence;

$competence = new Competence($client);
$skillData = $competence->getSkillInfo(/* parameters */);

Facade

Provides a simplified interface for common operations.

use Namespace\Path\PoleEmploiFacade;

$data = PoleEmploiFacade::get(/* parameters */);

Contributing

Contributions are welcome and will be fully credited. I accept contributions via Pull Requests on Github.

ogrre / laravel-pole-emploi

Maintainers

Details