Rechercher des entreprises

Présentation

Cette ressource permet de récupérer les entreprises à fort potentiel d’embauche (par ordre de score décroissant).

 

Description de la requête

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 :

  • dpae → résultats basés sur les DPAE, Déclaration Préalable À l'Embauche (valeur par défaut)
  • alternance → résultats basés sur les contrats d'alternance
latitude

0,1

Conditionné

Float

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é

Float

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ètres) autour du point géographique défini par le couple longitude / latitude ou le code INSEE de la commune.

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

rome_codes

0,n

Conditionné

String

Codes métiers ROME (exemple : "A1501") pour lesquels des entreprises embauchent potentiellement.

Vous devez utiliser soit `rome_codes`, soit `rome_codes_keyword_search`. Il est fortement recommandé d'utiliser `romes_codes` qui donnera en général des résultats de meilleure qualité.

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

rome_codes_keyword_search

0,1

Conditionné

String

Mots clé (exemple : "boucher" ou "animateur vente") utilisés pour déterminer automatiquement un code ROME.

Vous devez utiliser soit `rome_codes_keyword_search`, soit `rome_codes`. Il est fortement recommandé d'utiliser `romes_codes` qui donnera en général des résultats de meilleure qualité.

Attention : réponse 400 si aucun ROME ne matche les mots clés demandés.

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.

Ce champ est optionnel, par défaut la recherche s'étendra automatiquement à tous les codes NAF pertinents pour le code ROME demandé.

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 20 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 Found) est réalisée du domaine https://api.emploi-store.fr/api/lbb/v1/company vers le domaine https://labonneboite.pole-emploi.fr/api/v1/company/.

Vous devez explicitement indiquer à votre client HTTP de suivre les redirections car il ne le fait probablement pas par défaut. Par exemple pour le client curl, il est nécéssaire d'utiliser curl --location (ou curl -L).

 

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 Enseigne de l'entreprise si disponible, sinon raison sociale
companies.address 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ètres)
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 Float Longitude du point géographique de l'entreprise
companies.lat 1,1 Float Latitude du point géographique de l'entreprise
companies.raison_sociale 1,1 String Raison sociale de l'entreprise
match_rome_code 1,1 String Code ROME le plus pertinent (parmi ceux présents dans la requête)
match_rome_label 1,1 String Libellé du ROME le plus pertinent (parmi ceux présents dans la requête)
match_rome_slug 1,1 String Slug du libellé du ROME le plus pertinent (parmi ceux présents dans la requête)
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
url 1,1 String URL frontend de la recherche si possible, ou sinon URL de la page d'accueil
rome_code 1,1 String Code ROME utilisé pour la recherche
rome_label 1,1 String Libellé du code ROME utilisé pour 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",
      "raison_sociale": "CAISSE D'EPARGNE ET DE PREVOYANCE",
      "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",
      "raison_sociale": "ARTISANS RADIO TAXIS DE METZ",
      "siret": "31807235200020",
      "stars": 4,
      "url": "http://labonneboite.pole-emploi.fr/31807235200020/details"
    }],
  "companies_count": 649,
  "rome_code": "M1607",
  "rome_label": "Secrétariat",
  "url": "https://labonneboite.pole-emploi.fr/"
}

 

Cas d'erreurs possibles

Retrouvez la liste des cas d'erreurs possibles sur la page Erreurs Types.

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.

 

Syntaxe de la requête erronnée :

HTTP 400 Bad request
Content-Type: application/json
Cache-Control: no-store
Pragma: no-cache

{
  "codeErreur": "1493122545783",
  "codeHttp": 400,
  "message": "Aucun code_rome trouvé"
}

La réponse 400 s'accompagne d'un message explicite qui vous indique le problème rencontré par votre requête :

  • code_commune inconnu
  • Aucun code_rome trouvé (uniquement si vous utilisez rome_code_keyword_search)