Référentiels

Accédez aux différents référentiel utilisés par les API

Demander un accès

Présentation

Pour enrichir et faciliter l'utilisation des API, plusieurs référentiels sont disponibles, permettant de consulter des informations complémentaires indispensables à la recherche et la consultation des données.

Documentation

Caractéristiques

Mode d'accès
public
Fréquence de mise à jour
temps réel

Annuaire Structure Types

Appel

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

Données retournées

Code

Type

Informations

id

int

identifiant unique

libelle

varchar 200

libellé

ordre

int

ordre d'affichage

Exemple de retour

{
    "results": [
        {
            "id": 6,
            "libelle": "Cheops régional",
            "ordre": 0
        },
        {
            "id": 7,
            "libelle": "Cheops national",
            "ordre": 0
        },
        {
            "id": 1,
            "libelle": "Siège",
            "ordre": 1
        },
        {
            "id": 2,
            "libelle": "Antenne",
            "ordre": 2
        },
        {
            "id": 3,
            "libelle": "Permanence",
            "ordre": 3
        },
        {
            "id": 4,
            "libelle": "LUA France Travail",
            "ordre": 4
        },
        {
            "id": 5,
            "libelle": "Partenaire",
            "ordre": 5
        }
    ],
    "total": 7,
    "success": true
}

ÉVÉNEMENTS Types

Appel

GET https://api.capemploi.info/EvenementTypes```
/

Données retournées

Exemple de retour

{
    "results": [
        {
            "id": 1,
            "ordre": 1,
            "libelle": "Action sensibilisation"
        },
        {
            "id": 2,
            "ordre": 2,
            "libelle": " Atelier"
        },
        {
            "id": 3,
            "ordre": 3,
            "libelle": "Caravane"
        },
        {
            "id": 4,
            "ordre": 4,
            "libelle": "Cérémonie"
        },
        {
            "id": 5,
            "ordre": 5,
            "libelle": "Colloque"
        },
        {
            "id": 6,
            "ordre": 6,
            "libelle": "Conférence"
        },
        {
            "id": 7,
            "ordre": 7,
            "libelle": "Congrès"
        },
        {
            "id": 8,
            "ordre": 8,
            "libelle": "Exposition"
        },
        {
            "id": 9,
            "ordre": 9,
            "libelle": "Forum"
        },
        {
            "id": 10,
            "ordre": 10,
            "libelle": "Job dating"
        },
        {
            "id": 11,
            "ordre": 11,
            "libelle": "Petit déjeuner"
        },
        {
            "id": 12,
            "ordre": 12,
            "libelle": "Portes ouvertes"
        },
        {
            "id": 13,
            "ordre": 13,
            "libelle": "Réunion d'information"
        },
        {
            "id": 14,
            "ordre": 14,
            "libelle": "Séminaire"
        },
        {
            "id": 15,
            "ordre": 15,
            "libelle": "Visites d'entreprise"
        },
        {
            "id": 16,
            "ordre": 16,
            "libelle": "Webinaire"
        },
        {
            "id": 17,
            "ordre": 17,
            "libelle": "Salon en ligne"
        },
        {
            "id": 99,
            "ordre": 99,
            "libelle": "Autre"
        }
    ],
    "total": 18,
    "success": true
}

ÉVÉNEMENTS Objectifs

Appel

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

Données retournées

Code

Type

Informations

id

int

identifiant unique

libelle

varchar 200

libellé

ordre

int

ordre d'affichage

Exemple de retour

{
    "results": [
        {
            "id": 1,
            "libelle": "Aides à l'emploi",
            "ordre": 1
        },
        {
            "id": 2,
            "libelle": "Création d'entreprise",
            "ordre": 2
        },
        {
            "id": 3,
            "libelle": "Découverte formation",
            "ordre": 3
        },
        {
            "id": 4,
            "libelle": "Découverte secteur / métier",
            "ordre": 4
        },
        {
            "id": 5,
            "libelle": "Insertion",
            "ordre": 5
        },
        {
            "id": 6,
            "libelle": "International",
            "ordre": 6
        },
        {
            "id": 13,
            "libelle": "Maintien dans l'emploi",
            "ordre": 7
        },
        {
            "id": 7,
            "libelle": "Marché du travail",
            "ordre": 8
        },
        {
            "id": 8,
            "libelle": "Recrutement",
            "ordre": 9
        },
        {
            "id": 9,
            "libelle": "Recrutement sans CV",
            "ordre": 10
        },
        {
            "id": 10,
            "libelle": "Se préparer",
            "ordre": 11
        },
        {
            "id": 11,
            "libelle": "S'informer",
            "ordre": 12
        },
        {
            "id": 12,
            "libelle": "Sport et insertion",
            "ordre": 13
        }
    ],
    "total": 13,
    "success": true
}

ÉVÉNEMENTS Prérequis

Appel

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

Données retournées

Code

Type

Informations

id

int

identifiant unique

libelle

varchar 200

libellé

ordre

int

ordre d'affichage

Exemple de retour

{
    "results": [
        {
            "id": 1,
            "libelle": "diplôme",
            "ordre": 0
        },
        {
            "id": 2,
            "libelle": "savoir-être",
            "ordre": 0
        },
        {
            "id": 3,
            "libelle": "âge",
            "ordre": 0
        },
        {
            "id": 4,
            "libelle": "permis",
            "ordre": 0
        },
        {
            "id": 5,
            "libelle": "contraintes",
            "ordre": 0
        }
    ],
    "total": 5,
    "success": true
}

Offres d'emploi Nature Contrat

Appel

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

Données retournées

Code

Type

Informations

code

varchar

identifiant unique

libelle

varchar 200

libellé de l'objectif

Exemple de retour

{
    "results": [
        {
            "code": "FA",
            "libelle": "Act. Formation pré.recrut."
        },
        {
            "code": "CC",
            "libelle": "CDI de chantier ou d’opération"
        },
        {
            "code": "FS",
            "libelle": "Cont. professionnalisation"
        },
        {
            "code": "E2",
            "libelle": "Contrat apprentissage"
        },
        {
            "code": "EE",
            "libelle": "Contrat d'Engagement Educatif"
        },
        {
            "code": "CU",
            "libelle": "Contrat d'usage"
        },
        {
            "code": "CI",
            "libelle": "Contrat intermittent"
        },
        {
            "code": "FJ",
            "libelle": "Contrat pacte"
        },
        {
            "code": "PR",
            "libelle": "Contrat PrAB"
        },
        {
            "code": "E1",
            "libelle": "Contrat travail"
        },
        {
            "code": "FT",
            "libelle": "CUI - CAE"
        },
        {
            "code": "FU",
            "libelle": "CUI - CIE"
        },
        {
            "code": "FX",
            "libelle": "Emploi Avenir marchand"
        },
        {
            "code": "FW",
            "libelle": "Emploi Avenir non marchand"
        },
        {
            "code": "FY",
            "libelle": "Emploi Avenir Professeur"
        },
        {
            "code": "NS",
            "libelle": "Emploi non salarié"
        },
        {
            "code": "ER",
            "libelle": "Engagement à servir dans la réserve"
        },
        {
            "code": "I1",
            "libelle": "Insertion par l'activ.éco."
        },
        {
            "code": "PS",
            "libelle": "Portage salarial"
        },
        {
            "code": "FV",
            "libelle": "Prépa.opérationnel.emploi"
        }
    ],
    "total": 20,
    "success": true
}

Formations

Appel

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

Données retournées

Code

Type

Informations

code

varchar

identifiant unique

libelle

varchar 200

libellé de l'objectif

Exemple de retour

{
    "results": [
        {
            "libelle": "abattage",
            "code": "21598"
        },
        {
            "libelle": "accès handicapés",
            "code": "93020"
        },
        {
            "libelle": "accessibilité numérique",
            "code": "46253"
        },
        {
            "libelle": "accessoire mode",
            "code": "21752"
        },
                ...
        {
            "libelle": "zoologie",
            "code": "12032"
        },
        {
            "libelle": "zootechnie",
            "code": "12021"
        },
        {
            "libelle": "zoothérapie",
            "code": "14421"
        }
    ],
    "total": 3379,
    "success": true
}

Formations Niveaux

Appel

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

Données retournées

Code

Type

Informations

code

varchar

identifiant unique

libelle

varchar

libellé

sort

int

ordre d'affichage

Exemple de retour

{
    "results": [
        {
            "id": 6,
            "libelle": "Cheops régional",
            "ordre": 0
        },
        {
            "id": 7,
            "libelle": "Cheops national",
            "ordre": 0
        },
        {
            "id": 1,
            "libelle": "Siège",
            "ordre": 1
        },
        {
            "id": 2,
            "libelle": "Antenne",
            "ordre": 2
        },
        {
            "id": 3,
            "libelle": "Permanence",
            "ordre": 3
        },
        {
            "id": 4,
            "libelle": "LUA France Travail",
            "ordre": 4
        },
        {
            "id": 5,
            "libelle": "Partenaire",
            "ordre": 5
        }
    ],
    "total": 7,
    "success": true
}

Conditions et aptitudes

Appel

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

Données retournées

Code

Type

Informations

code

varchar

identifiant unique

libelle

varchar 200

libellé de l'objectif

Exemple de retour

{
    "results": [
        {
            "code": "APAP",
            "libelle": "Accès poste de travail : Accéder sans adaptation PMR"
        },
        {
            "code": "APCO",
            "libelle": "Accès poste de travail : Conduite automobile"
        },
                ...
        {
            "code": "TDTQ",
            "libelle": "Tolérance de travail : Travailler en équipe"
        },
        {
            "code": "TDSA",
            "libelle": "Tolérance de travail : Travailler seul en autonomie"
        },
        {
            "code": "TDSM",
            "libelle": "Tolérance de travail : Travailler sur machine dangereuse"
        },
        {
            "code": "TDPB",
            "libelle": "Tolérance physique : Bruit"
        }
    ],
    "total": 107,
    "success": true
}

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