API La Bonne Boite v1

Présentation

L’API La Bonne Boite permet de récupérer la liste des entreprises classées par potentiel d'embauche pour un métier (code ROME) et/ou une activité (code NAF) donné, et sur un secteur géographique ciblé.

Le potentiel d'embauche correspond à un score de 0 à 100 issu d’algorithmes et de données de Pôle emploi. Il indique la probabilité que l’établissement effectuera au moins une embauche dans les six prochains mois.

Un exemple d'implémentation OpenSource réalisé en Python par Bayes Impact est disponible sur GitHub.

 

Caractéristiques

Catégorie publique
Fréquence de mise à jour une fois par mois
Cinématique OAuth client credentials grant
Royaume Pôle Emploi Access Management partenaire
Scope api_labonneboitev1

 

Description de la requête

URL du point d'accès

GET https://api.emploi-store.fr/partenaire/labonneboite/v1/company/

 

Paramètres d'entrée

Code Cardinalité Format Description
commune_id

0,1

Conditionné

String

Code INSEE de la commune à proximité de laquelle on recherche des entreprises à fort potentiel d’embauche.

Si ce paramètre n'est pas renseigné, il est nécessaire d'indiquer la latitude et la longitude.

Référentiel : Géographie administrative de l'Insee

contract 0,1 String

Type de contrat

Valeurs possibles :

  • all : tous les types de contrat (valeur par défaut)
  • alternance : limiter aux contrats d'alternance
latitude

0,1

Conditionné

Double

Latitude du point géographique à proximité duquel on recherche des entreprises à fort potentiel d’embauche.

Si ce paramètre n'est pas renseigné, il est nécessaire d'indiquer le code INSEE de la commune.

longitude

0,1

Conditionné

Double

Longitude du point géographique à proximité duquel on recherche des entreprises à fort potentiel d’embauche.

Si ce paramètre n'est pas renseigné, il est nécessaire d'indiquer le code INSEE de la commune.

distance 0,n Integer

Périmètre du rayon de recherche (en kilomètre) autour du point géographique défini par le couple longitude / latitude.

Par défaut, cette distance est de 10 km.

rome_codes

1,1

String

Code métier ROME (exemple "A1501") pour lesquels des entreprises embauchent potentiellement.

Référentiel : Répertoire Opérationnel des Métiers et des Emplois

naf_codes 0,n String

Liste de codes métier NAF (exemple "9499Z,5610C") ou simplement un seul code métier (exemple "9499Z") associés aux entreprises.

Référentiel : Nomenclature d'activités française de l'Insee (rév. 2, 2008 - Niveau 2 - Liste des divisions)

headcount 0,1 String

Taille de l'entreprise

Valeurs possibles :

  • all : toutes les tailles (valeur par défaut)
  • small : moins de 50 salariés
  • big : plus de 50 salariés
page 0,1 Integer

Numéro de la page demandée.

Par défaut, la page restituée est la première.

page_size 0,1 Integer

Nombre de résultats par page.

Par défaut, le service restitue les 10 premiers résultats. La valeur maximale est 100.

sort 0,1 String

Ordre des résultats

Valeurs possibles :

  • score : tri par score (valeur par défaut)
  • distance : tri par distance

 

Exemple d'appel

GET https://api.emploi-store.fr/partenaire/labonneboite/v1/company/?distance=30&latitude=49.119146&longitude=6.17602&rome_codes=M1607

Authorization: Bearer [Access token]

 

Description de la réponse

Lors de la réponse de l'API, une redirection (code HTTP 302 Moved Temporarily) est réalisée vers le site La Bonne Boite.

 

Données retournées

Code Cardinalité Format Description
companies 0,n Object Liste des entreprises répondant aux critères
companies.siret 1,1 String Numéro de SIRET de l’entreprise
companies.name 1,1 String Nom de l’entreprise
companies.adresse 1,1 String Adresse de l’entreprise
companies.city 1,1 String Ville de l’entreprise
companies.contact_mode 1,1 String Mode de contact à privilégier pour contacter l'entreprise
companies.distance 1,1 Integer Distance du point géographique demandé (en kilomètre)
companies.headcount_text 1,1 String Libellé du nombre d’employés pour cette entreprise
companies.naf 1,1 String

Secteur d’activité de l’entreprise concernée

Référentiel : Nomenclature d'activités française de l'Insee (rév. 2, 2008 - Niveau 2 - Liste des divisions)

companies.naf_text 1,1 String

Libellé du secteur d’activité de l’entreprise concernée

Référentiel : Nomenclature d'activités française de l'Insee (rév. 2, 2008 - Niveau 2 - Liste des divisions)

companies.lon 1,1 Double Longitude du point géographique de l'entreprise
companies.lat 1,1 Double Latitude du point géographique de l'entreprise
companies.stars 1,1 Integer Potentiel d’embauche (nombre d'étoiles), de 0 à 5
companies.url 1,1 String Lien absolu vers la fiche de l'entreprise sur le site La Bonne Boite
companies.alternance 1,1 Boolean Candidatures pour de l’alternance possibles
companies_count 1,1 String Nombre total d'entreprises correspondant à la recherche

 

Exemple de retour

HTTP 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache

{
  "companies": [
    {
      "address": "CAISSE D'EPARGNE ET DE PREVOYANCE DE L, CAISSE D'EPARGNE, Service des ressources humaines, 5 PARVIS DES DROITS DE L HOMME, 57000 METZ",
      "alternance" : false,
      "city": "METZ",
      "contact_mode": "Envoyer un CV et une lettre de motivation",
      "distance": 0,
      "headcount_text": "250 à 499 salariés",
      "lat": 49.11613,
      "lon": 6.1727,
      "naf": "7010Z",
      "naf_text": "Activités des sièges sociaux",
      "name": "CAISSE D'EPARGNE",
      "siret": "77561862203725",
      "stars": 4,
      "url": "http://labonneboite.pole-emploi.fr/77561862203725/details"
    },
    {
      "address": "ARTISANS RADIO TAXIS DE METZ, , 2 RUE LAFAYETTE, 57000 METZ",
      "alternance" : true,
      "city": "METZ",
      "contact_mode": "Se présenter spontanément",
      "distance": 1,
      "headcount_text": "6 à 9 salariés",
      "lat": 49.109,
      "lon": 6.174795,
      "naf": "8299Z",
      "naf_text": "Autres activités de soutien aux entreprises nca",
      "name": "ARTISANS RADIO TAXIS DE METZ",
      "siret": "31807235200020",
      "stars": 4,
      "url": "http://labonneboite.pole-emploi.fr/31807235200020/details"
    }],
  "companies_count": 96
}

 

Cas d'erreurs possibles

Access token erroné ou absent :

HTTP 401 Unauthorized
Content-Type: application/json
Cache-Control: no-store
Pragma: no-cache

{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons."
}

 

API en cours de maintenance :

HTTP 502 Bad gateway
Content-Type: application/json
Cache-Control: no-store
Pragma: no-cache

L'API est susceptible de connaitre occasionnellement de brèves indisponibilités (micro-coupures pendant certains déploiements).
Par conséquent, votre application doit contrôler le code retour de l'API. Le code HTTP 502 signifie que l'API est temporairement indisponible. Vous pourrez retenter l'appel quelques secondes plus tard.