Annuaire v1

Accédez à toutes les structures liées au réseau Cap emploi

Demander un accès

Présentation

L'API Annuaire restitue en temps réel les structures du réseau de Cap emploi, ainsi que les LUA Pôles emploi rattachées via l'API.

Les ressources de l’API vous permettent de :

  • Réaliser une recherche de structure à partir de critères de sélection et récupérer une liste de résultats
  • Consulter le détail d'une structure (adresse, horaires, ...)

Documentation

Caractéristiques

Mode d'accès
privé avec clé API
Fréquence de mise à jour
temps réel

Rechercher des structures

Cette ressource permet de rechercher les informations d’une ou plusieurs structures à partir des critères suivants :

Paramètres d'entrée

Code

Type

Informations

annuaireStructureTypesId

Integer

Code du type de structure

Référentiel

context_key

String

Code de la structure référente (Siège du Cap emploi référent)

Liste possibles

Des combinaisons de critères sont possibles.

Exemples d'appel

GET https://api.capemploi.info/Annuaire/

GET https://api.capemploi.info/Annuaire/?annuaireStructureTypesId=2

GET https://api.capemploi.info/Annuaire/?context_key=capemploi-35

Données retournées

Données

Type

Informations

id

int

unique

annuaireStructureTypesId

int

Référentiel

annuaireStructureTypeLibelle

varchar

libellé lié à l'id structure

code

varchar

50, unique

structureNom

varchar

200

associationNom

varchar

200

associationSiret

varchar

50

associationEmail

varchar

150

associationTelephone

varchar

50

associationSiteweb

varchar

200

capemploiSiret

varchar

50

associationIsISO

boolean

précision si la structure est certifiée ISO

lieuNom

varchar

200

lieuAdresse

varchar

200

lieuCodePostal

varchar

10

lieuVille

varchar

200

courrierAdresseActif

boolean

précision si une adresse postale existe

courrierAdresse

varchar

200

courrierCodePostal

varchar

10

courrierVille

varchar

200

accesTransports

text

libre

horairesOuverture

horairesOuverture

au format JSON

accesLibreLien

varchar

200, lien vers la page accès libre du batiment

published

bolean

lieuGeolocalisation

text

couple latitude et longitude

context_key

varchar

50, clé de la structure principale Cap emploi (siège social)

horairesStandard

text

précisions sur les heures d'ouverture du standard téléphonique

ctx

text

informations supplémentaire de la structure (l'URL et nom générique)

Exemple de retour

{
    "results": [
        {
            "id": 260,
            "annuaireStructureTypesId": 2,
            "code": "rLCttvgVMNRAnzutgY3TWB7zgGqdySAG",
            "structureNom": "Pontivy",
            "associationNom": " ",
            "associationSiret": "",
            "associationEmail": "contact@capemploi56.fr",
            "associationTelephone": "02 97 25 22 73",
            "associationSiteweb": "",
            "capemploiSiret": "",
            "associationIsISO": false,
            "lieuNom": "",
            "lieuAdresse": "1 Rue des Eglantines",
            "lieuCodePostal": "56300",
            "lieuVille": "PONTIVY ",
            "courrierAdresse": "",
            "courrierCodePostal": "",
            "courrierVille": "",
            "accesTransports": "",
            "horairesOuverture": "[{\"MIGX_id\":\"1\",\"jour\":\"lundi\",\"ouverture-heure-1\":\"13\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"17\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"0\",\"ouverture-minute-2\":\"00\",\"fermeture-heure-2\":\"0\",\"fermeture-minute-2\":\"00\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"2\",\"jour\":\"mardi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"3\",\"jour\":\"mercredi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"4\",\"jour\":\"jeudi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"5\",\"jour\":\"vendredi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"}]",
            "accesLibreLien": "",
            "published": true,
            "lieuGeolocalisation": {
                "latitude": "48.0796984",
                "longitude": "-2.9656888"
            },
            "context_key": "capemploi-56",
            "courrierAdresseActif": false,
            "horairesStandard": "",
            "annuaireStructureTypeLibelle": "Antenne",
            "ctx": {
                "page_signalement": "",
                "page_offresEmploi": "https://www.capemploi-56.com/emploi/",
                "region": "Bretagne",
                "nom_generique": "Cap emploi 56",
                "site_url": "https://www.capemploi-56.com/"
            }
        },
        {
            "id": 261,
            "annuaireStructureTypesId": 2,
            "code": "JedQvMY7GFemVekWbVJvC3ZU7ucb7Ymm",
            "structureNom": "Lorient",
            "associationNom": "",
            "associationSiret": "",
            "associationEmail": "contact@capemploi56.fr",
            "associationTelephone": "02 97 76 72 72",
            "associationSiteweb": "",
            "capemploiSiret": "",
            "associationIsISO": false,
            "lieuNom": "",
            "lieuAdresse": "5 rue Simone Signoret - Immeuble « Le Transat » ",
            "lieuCodePostal": "56100",
            "lieuVille": "LORIENT ",
            "courrierAdresse": "",
            "courrierCodePostal": "",
            "courrierVille": "",
            "accesTransports": "",
            "horairesOuverture": "[{\"MIGX_id\":\"1\",\"jour\":\"lundi\",\"ouverture-heure-1\":\"13\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"17\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"0\",\"ouverture-minute-2\":\"00\",\"fermeture-heure-2\":\"0\",\"fermeture-minute-2\":\"00\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"2\",\"jour\":\"mardi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"3\",\"jour\":\"mercredi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"4\",\"jour\":\"jeudi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"5\",\"jour\":\"vendredi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"}]",
            "accesLibreLien": "",
            "published": true,
            "lieuGeolocalisation": {
                "latitude": "47.7583732",
                "longitude": "-3.3863823"
            },
            "context_key": "capemploi-56",
            "courrierAdresseActif": false,
            "horairesStandard": "",
            "annuaireStructureTypeLibelle": "Antenne",
            "ctx": {
                "page_signalement": "",
                "page_offresEmploi": "https://www.capemploi-56.com/emploi/",
                "region": "Bretagne",
                "nom_generique": "Cap emploi 56",
                "site_url": "https://www.capemploi-56.com/"
            }
        },
        {
            "id": 262,
            "annuaireStructureTypesId": 2,
            "code": "bbcbmTAHmmgZJuK7sXzCdW9DyGbVdyY8",
            "structureNom": "Vannes",
            "associationNom": "",
            "associationSiret": "",
            "associationEmail": "contact@capemploi56.fr",
            "associationTelephone": "02 97 47 62 30",
            "associationSiteweb": "",
            "capemploiSiret": "",
            "associationIsISO": false,
            "lieuNom": "PA Laroiseau",
            "lieuAdresse": "2 rue Ella Maillart",
            "lieuCodePostal": "56000",
            "lieuVille": "Vannes",
            "courrierAdresse": "",
            "courrierCodePostal": "",
            "courrierVille": "",
            "accesTransports": "",
            "horairesOuverture": "[{\"MIGX_id\":\"1\",\"jour\":\"lundi\",\"ouverture-heure-1\":\"13\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"17\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"0\",\"ouverture-minute-2\":\"00\",\"fermeture-heure-2\":\"0\",\"fermeture-minute-2\":\"00\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"2\",\"jour\":\"mardi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"3\",\"jour\":\"mercredi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"4\",\"jour\":\"jeudi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"5\",\"jour\":\"vendredi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"}]",
            "accesLibreLien": "",
            "published": false,
            "lieuGeolocalisation": {
                "latitude": "47.66795425527093",
                "longitude": "-2.7810000871025187"
            },
            "context_key": "capemploi-56",
            "courrierAdresseActif": false,
            "horairesStandard": "",
            "annuaireStructureTypeLibelle": "Antenne",
            "ctx": {
                "page_signalement": "",
                "page_offresEmploi": "https://www.capemploi-56.com/emploi/",
                "region": "Bretagne",
                "nom_generique": "Cap emploi 56",
                "site_url": "https://www.capemploi-56.com/"
            }
        }
    ],
    "total": 3,
    "success": true
}

Consulter une structure

Cette ressource permet de consulter le détail d'une structure.

Paramètres d'entrée

Code

Type

Informations

id

int

identifiant unique de la structure

Exemples d'appel

GET https://api.capemploi.info/Annuaire/260

Données retournées

Données

Type

Informations

id

int

unique

annuaireStructureTypesId

int

Référentiel

annuaireStructureTypeLibelle

varchar

libellé lié à l'id structure

code

varchar

50, unique

structureNom

varchar

200

associationNom

varchar

200

associationSiret

varchar

50

associationEmail

varchar

150

associationTelephone

varchar

50

associationSiteweb

varchar

200

capemploiSiret

varchar

50

associationIsISO

boolean

précision si la structure est certifiée ISO

lieuNom

varchar

200

lieuAdresse

varchar

200

lieuCodePostal

varchar

10

lieuVille

varchar

200

courrierAdresseActif

boolean

précision si une adresse postale existe

courrierAdresse

varchar

200

courrierCodePostal

varchar

10

courrierVille

varchar

200

accesTransports

text

libre

horairesOuverture

horairesOuverture

au format JSON

accesLibreLien

varchar

200, lien vers la page accès libre du batiment

published

bolean

lieuGeolocalisation

text

couple latitude et longitude

context_key

varchar

50, clé de la structure principale Cap emploi (siège social)

horairesStandard

text

précisions sur les heures d'ouverture du standard téléphonique

ctx

text

informations supplémentaire de la structure (l'URL et nom générique)

Exemple de retour

{
    "results": [
        {
            "id": 260,
            "annuaireStructureTypesId": 2,
            "code": "rLCttvgVMNRAnzutgY3TWB7zgGqdySAG",
            "structureNom": "Pontivy",
            "associationNom": " ",
            "associationSiret": "",
            "associationEmail": "contact@capemploi56.fr",
            "associationTelephone": "02 97 25 22 73",
            "associationSiteweb": "",
            "capemploiSiret": "",
            "associationIsISO": false,
            "lieuNom": "",
            "lieuAdresse": "1 Rue des Eglantines",
            "lieuCodePostal": "56300",
            "lieuVille": "PONTIVY ",
            "courrierAdresse": "",
            "courrierCodePostal": "",
            "courrierVille": "",
            "accesTransports": "",
            "horairesOuverture": "[{\"MIGX_id\":\"1\",\"jour\":\"lundi\",\"ouverture-heure-1\":\"13\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"17\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"0\",\"ouverture-minute-2\":\"00\",\"fermeture-heure-2\":\"0\",\"fermeture-minute-2\":\"00\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"2\",\"jour\":\"mardi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"3\",\"jour\":\"mercredi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"4\",\"jour\":\"jeudi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"},{\"MIGX_id\":\"5\",\"jour\":\"vendredi\",\"ouverture-heure-1\":\"8\",\"ouverture-minute-1\":\"30\",\"fermeture-heure-1\":\"12\",\"fermeture-minute-1\":\"30\",\"rendez-vous-uniquement-1\":\"non\",\"masquer-horaires-1\":\"non\",\"ouverture-heure-2\":\"13\",\"ouverture-minute-2\":\"30\",\"fermeture-heure-2\":\"17\",\"fermeture-minute-2\":\"30\",\"rendez-vous-uniquement-2\":\"non\",\"masquer-horaires-2\":\"non\"}]",
            "accesLibreLien": "",
            "published": true,
            "lieuGeolocalisation": {
                "latitude": "48.0796984",
                "longitude": "-2.9656888"
            },
            "context_key": "capemploi-56",
            "courrierAdresseActif": false,
            "horairesStandard": "",
            "annuaireStructureTypeLibelle": "Antenne",
            "ctx": {
                "page_signalement": "",
                "page_offresEmploi": "https://www.capemploi-56.com/emploi/",
                "region": "Bretagne",
                "nom_generique": "Cap emploi 56",
                "site_url": "https://www.capemploi-56.com/"
            }
        }
    ],
    "total": 1,
    "success": true
}

Référentiels

Liste des référentiels utilisés pour l'API "Annuaire"

Postman

Collection Postman

Lors de votre demande d'accès à l'API, vous pouvez recevoir si besoin une collection postman complète.

Variables de la collection

Au sein de la collection, vous trouverez 4 variables :

  • apiKey (votre identifiant)
  • apiKeySecret (mot de passe)
  • urlServer (url de l'API)
  • token (ne pas toucher, cette variable vit par elle-même)

Les valeurs sont enregistrées directement dans la collection

Information sur le token

Vous retrouverez dans l'onglet "pre-request Script" l'appel effectué pour la création du token (stocké dans la variable).

C'est ce token qui est utilisé ensuite pour chaque appel.

Contenus de la collection

  • Le dossier Partenaires liste les différents endpoints qui vous sont autorisés.
  • Le dossier Référentiels liste les référentiels qui peuvent vous être utiles.

Licence