Présentation
L'API Événements restitue en temps réel les événements du réseau de Cap emploi via l'API.
Les ressources de l’API vous permettent de :
- Réaliser une recherche d'événements à partir de critères et récupérer une liste de résultats
- Consulter le détail d'un événement (description, objectifs, informations pratiques, ...)
Documentation
Caractéristiques
- Mode d'accès
- privé avec clé API
- Fréquence de mise à jour
- temps réel
Rechercher des événements
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 |
---|---|---|
evenementTypesId |
Integer |
Code du type d'événement |
context_key |
String |
Code de la structure référente (Siège du Cap emploi référent) |
dateDebut |
timestamp |
date définissant le début de la recherche |
dateFin |
timestamp |
date définissant la fin de la recherche |
Des combinaisons de critères sont possibles.
Exemples d'appel
GET https://api.capemploi.info/Evenements/
GET https://api.capemploi.info/Evenements/?evenementTypesId=2
GET https://api.capemploi.info/Evenements/?context_key=capemploi-35
GET https://api.capemploi.info/Evenements/?dateDebut=1691336800
Données retournées
Données |
Type |
Informations |
---|---|---|
id |
int |
unique |
latitude |
varchar 20 |
20, latitude cordonnées GPS |
longitude |
varchar |
20, longitude cordonnée GPS |
partenaires |
varchar |
JSON |
referentNom |
varchar |
200 |
referentPrenom |
varchar |
200 |
referentFonction |
varchar |
200 |
referentTelephone |
varchar |
50 |
referentEmail |
varchar |
200 |
pieceJointe_mediaId |
int |
10, pièce jointe liée à l'événement, voir donnée pieceJointeMedia |
illustration_mediaId |
int |
10, voir donnée illustrationMedia |
evenementSemaineEuropeenne |
boolean |
participe à la SEEPH |
evenementCapemploi |
boolean |
est un événement Cap emploi |
lienPublic |
varchar |
255, lien externe vers l'événement |
publicCiblePublic |
boolean |
cible grand public |
publicCiblePro |
boolean |
cible profesionnelles |
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": 1321,
"latitude": "48.118477",
"longitude": "-1.600392",
"partenaires": "[\"France Travail\"]",
"referentFonction": "collaborateur",
"referentTelephone": "",
"referentEmail": "contact@capemploi35.com",
"referentPrenom": "Cap",
"referentNom": "Emploi 35",
"pieceJointe_mediaId": 0,
"evenementSemaineEuropeenne": false,
"evenementCapemploi": false,
"lienPublic": "https://www.helloasso.com/associations/forum-emploi-cesson/evenements/entree-visiteur",
"illustration_mediaId": 1084,
"publicCible": 0,
"accessibiliteModalites": "[]",
"accessibiliteLieu": true,
"adresseVille": "Cesson-Sévigné",
"adresseCp": "35510",
"adresseTypeVoie": "boulevard",
"adresseVoie": "Boulevard de Dézerseul",
"adresseNumero": "1",
"lienConnexion": "",
"dates": "[{\"date\":\"15/05/2024\",\"informations\":\"9h-17h\"}]",
"code": "aLgLtkRgJTbs9maS4LLRJgbgTrcTyQBhQ5vJYA5JGPtz8yf4HR",
"context_key": "capemploi-35",
"format": 1,
"lienExterne": "https://www.helloasso.com/associations/forum-emploi-cesson/evenements/entree-visiteur",
"description": "La 7eme édition du Forum de l'Emploi organisé par MENSA Formation en partenariat avec la mairie de Cesson Sevigné est lancée ! \r\nCelle-ci aura lieu le 15 mai 2024 de 9h à 17h à Cesson Sevigne au Gymnase Paul Janson.",
"titre": "FEC - Forum Emploi Cesson",
"evenementTypesId": 9,
"partenairesAutres": "Weker, Mensa, Ville de Cesson Sévigné",
"source": "",
"adresseLieu": "",
"objectifIds": "[\"1\",\"2\",\"3\",\"5\",\"8\",\"11\"]",
"publicCiblePublic": true,
"publicCiblePro": true,
"participationCapemploi": true,
"referentOrganisme": "Cap emploi 35",
"pieceJointeLabel": "Flyer FEC",
"prerequisDetails": "",
"prerequisIds": "[]",
"dateDebut": 1715724000,
"published": true,
"archive": false,
"dateFin": 1715724000,
"illustrationMedia": {
"mime": "image/png",
"filename": "Affiche FEC_1426963523.png",
"url": "https://cdn.data-cheops.ovh/?c=Tqv4RQlFtgk7kzY29BsLvdj73Czh2rZKraLo4MMnvrXCHRyZ8X8ZbABON3MiTOqcqzeUTkaphfTKxqdqs2e9"
},
"evenementTypeLibelle": "Forum",
"objectifs": [
{
"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": 5,
"libelle": "Insertion",
"ordre": 5
},
{
"id": 8,
"libelle": "Recrutement",
"ordre": 9
},
{
"id": 11,
"libelle": "S'informer",
"ordre": 12
}
],
"prerequis": [],
"permalien": "https://www.capemploi-35.com/evenements/evenement.html?i=1321&c=aLgLtkRgJTbs9maS4LLRJgbgTrcTyQBhQ5vJYA5JGPtz8yf4HR",
"ctx": {
"type": "cap-emploi",
"region": "Bretagne",
"nom_generique": "Cap emploi 35",
"site_url": "https://www.capemploi-35.com/"
}
}
],
"total": 1,
"success": true
}
Consulter un événement
Cette ressource permet de consulter le détail d'un événement
Paramètres d'entrée
Code |
Type |
Informations |
---|---|---|
id |
int |
identifiant unique de l'événement |
Exemples d'appel
GET {{urlServer}}Evenements/55
Données retournées
Données |
Type |
Informations |
---|---|---|
id |
int |
unique |
latitude |
varchar 20 |
20, latitude cordonnées GPS |
longitude |
varchar |
20, longitude cordonnée GPS |
partenaires |
varchar |
JSON |
referentNom |
varchar |
200 |
referentPrenom |
varchar |
200 |
referentFonction |
varchar |
200 |
referentTelephone |
varchar |
50 |
referentEmail |
varchar |
200 |
pieceJointe_mediaId |
int |
10, pièce jointe liée à l'événement, voir donnée pieceJointeMedia |
illustration_mediaId |
int |
10, voir donnée illustrationMedia |
evenementSemaineEuropeenne |
boolean |
participe à la SEEPH |
evenementCapemploi |
boolean |
est un événement Cap emploi |
lienPublic |
varchar |
255, lien externe vers l'événement |
publicCiblePublic |
boolean |
cible grand public |
publicCiblePro |
boolean |
cible profesionnelles |
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
{
"success": true,
"message": "",
"object": {
"id": 55,
"latitude": "45.833101",
"longitude": "1.258896",
"partenaires": "[]",
"referentFonction": "Assistante Administrative",
"referentTelephone": "05.55.38.89.00",
"referentEmail": "contact@capemploiXX.fr",
"referentPrenom": "Clémence ",
"referentNom": " FOURCADE",
"pieceJointe_mediaId": 0,
"evenementSemaineEuropeenne": false,
"evenementCapemploi": false,
"lienPublic": "",
"illustration_mediaId": 0,
"publicCible": 0,
"accessibiliteModalites": "[]",
"accessibiliteLieu": true,
"adresseVille": "Limoges",
"adresseCp": "87000",
"adresseTypeVoie": "boulevard",
"adresseVoie": "de Beaublanc",
"adresseNumero": "20",
"lienConnexion": "",
"dates": "[{\"date\":\"15/03/2023\",\"informations\":\"\"}]",
"code": "PmYPM4FxzpzVsxP9Am2Uf8h2UkAMZ5eGAGVGVW9CtmQVbEyDXB",
"context_key": "capemploi-87",
"format": 1,
"lienExterne": "",
"description": "Destination Alternance",
"titre": "Destination Alternance",
"evenementTypesId": 13,
"partenairesAutres": "",
"source": "cap-emploi",
"adresseLieu": "ERIP de Limoges",
"objectifIds": "[\"8\"]",
"publicCiblePublic": true,
"publicCiblePro": false,
"participationCapemploi": true,
"referentOrganisme": "Cap emploi 87",
"pieceJointeLabel": "",
"prerequisDetails": "",
"prerequisIds": "[\"2\"]",
"dateDebut": 1678834800,
"published": true,
"archive": false,
"dateFin": 1678834800,
"evenementTypeLibelle": "Réunion d'information",
"objectifs": [
{
"id": 8,
"libelle": "Recrutement",
"ordre": 9
}
],
"prerequis": [
{
"id": 2,
"libelle": "savoir-être",
"ordre": 0
}
],
"permalien": "https://www.capemploi-87.com/evenements/evenement.html?i=55&c=PmYPM4FxzpzVsxP9Am2Uf8h2UkAMZ5eGAGVGVW9CtmQVbEyDXB",
"ctx": {
"type": "cap-emploi",
"region": "Nouvelle-Aquitaine",
"nom_generique": "Cap emploi 87",
"site_url": "https://www.capemploi-87.com/"
}
},
"code": 200
}
Référentiels
Liste des référentiels utilisés pour l'API "Événements"
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.