✒️
Documentation API Engagement
Documentation Produit
Documentation Produit
  • INTRODUCTION
    • Qu'est ce que l'API Engagement ?
    • À qui s'adresse l'API Engagement ?
    • Comment devenir partenaire ?
  • ANNONCEUR
    • Partager des missions d'engagement
    • Étape 1 : créer d'un flux XML
      • Format du flux XML
      • Liste des champs à inclure dans le flux XML
      • Conditions d'utilisation du flux XML
    • Étape 2 : tracker des candidatures
      • Rajout de la balise et des commandes de tracking par le tag
      • Tracking de l'activité par API
    • Modération des missions partagées
      • Modération API Engagement
      • Modération des partenaires "diffuseur"
  • Diffuseur
    • Diffuser des missions d'engagement sur mon site
      • Diffuser des missions par API
      • Diffuser des missions par widget
      • Diffuser des missions par lien tracké
    • Modèle de données d'une mission d'engagement
    • Partager les données de diffusion sur mon site à l'API Engagement
      • Missions non diffusées sur mon site
      • Partager vos statistiques de diffusions (impressions) à l'API Engagement
        • Par envoi de fichier csv.
        • Par la mise en place d'un tag (ou pixel) sur votre site
      • Identifier l’origine d’une redirection à l’aide de tags
  • RESSOURCES
    • Traitement des données utilisateurs
Powered by GitBook
On this page
  • Champs principaux
  • Caractéristiques de la mission
  • Champs géographiques de la mission
  • Champs de l'organisation ou de la structure d'accueil
  1. ANNONCEUR
  2. Étape 1 : créer d'un flux XML

Liste des champs à inclure dans le flux XML

Champs principaux

Nom du champs
Type
Description

title

String

Titre de votre mission. Requis

clientId

String

Identifiant de la mission. Requis

applicationUrl

String

Lien de candidature de la mission. Requis

postedAt

Date

Date à laquelle la mission a été postée. Défaut now()

startAt

Date

Date de début de la mission. Défaut now()

endAt

Date

Date de fin de la mission

Caractéristiques de la mission

Nom du champs
Type
Description

description

String

La description de votre mission, peut contenir des balises HTML. Requis

domain

String

Domaine de la mission.

1 valeur possible parmi :

"environnement",

"solidarite-insertion",

"prevention-protection",

"sante",

"culture-loisirs",

"education",

"emploi",

"sport",

"humanitaire",

"animaux",

"vivre-ensemble",

"memoire-et-citoyennete",

"benevolat-competences", ou "autre"

activity

String

Activité de la mission.

1 valeur possible parmi : "taches-administratives",

"conseil",

"collecte",

"informatique",

"logistique",

"mission-internationale",

"alphabetisation",

"jardinage",

"animation",

"communication",

"aide-psychologique",

"activites-manuelles",

"encadrement-d-equipes",

"bricolage",

"sante-soins",

"visites",

"distribution",

"soutien-scolaire",

"documentation-traduction",

"gestion-recherche-des-partenariats",

"ecoute-permanence",

"recrutement",

"responsabilites-associatives",

"juridique",

"accueil-de-public",

"enseignement-formation",

"comptabilite-finance",

"secourisme",

"gestion-de-projets",

"mentorat-parrainage",

"sport",

"art" ou

"autre"

schedule

String

Rythme de la mission. Exemple : "1 demi-journée par semaine"

places

Number

Nombre de places disposnibles pour la mission Défaut 1

remote

String

Mission disponible en distanciel.

Valeurs possibles:

"possible", "full" ou "no"

image

String

Lien url de l'image de la mission. Si vous n'en fournissez pas, l'API Engagement utilisera l'une des images de sa bibliothèque en fonction du domaine.

audience

String[]

Les bénéficiaires de la mission / à qui la mission s'adresse. Exemple 1: "Tous publics" Exemple 2: "Jeunes, Adultes"

softSkills

String[]

Les compétences générales requises pour la mission Exemple : "Écoute active, Communication orale"

reducedMobilityAccessible

String

Mission accessible pour les personnes à mobilité réduite.

Valeurs possibles:

"yes" ou "no"

closeToTransport

String

Mission proche des transports en commun.

Valeurs possibles:

"yes" ou "no"

openToMinors

String

Mission ouverte aux mineurs.

Valeurs possibles:

"yes" ou "no"

tags

String[]

Ce champs permet de tagguer vos missions avec un, ou plusieurs mots-clés personnalisés séparés par une virgule, dans l’API. Exemple 1: "Ecologie" Exemple 2: "Ecologie, Sport, Solidarité"

priority

String

Priorité de la mission

metadata

String

Métadata de la mission

Champs géographiques de la mission

Il s’agit de l’ensemble des localisations où se déroulent la mission.

Si vos missions se tiennent dans plusieurs lieux alors vous pouvez renseigner ces localisations dans le champs addresses qui est un tableau d'objects contenant le détail géographique de chaque mission.

Si vos missions ne se tiennent dans un lieu unique, vous ne renseignez qu'une seule adresse dans le tableau addresses.

Exemple d'une mission avec une adresse unique

<addresses>
  <address>
    <street><![CDATA[10 rue de la Paix]]></street>
    <postalCode><![CDATA[75001]]></postalCode>
    <city><![CDATA[Paris]]></city>
    <departmentCode><![CDATA[75]]></departmentCode>
    <departmentName><![CDATA[Paris]]></departmentName>
    <region><![CDATA[Centre-Val de Loire]]></region>
    <country><![CDATA[FR]]></country>
    <location>
      <lat><![CDATA[47.8951]]></lat>
      <lon><![CDATA[1.9108]]></lon>
    </location>
  </address>
</addresses>

Exemple d'une mission avec plusieurs addresses

<addresses>
  <address>
    <street><![CDATA[10 rue de la Paix]]></street>
    <postalCode><![CDATA[75001]]></postalCode>
    <city><![CDATA[Paris]]></city>
    <departmentCode><![CDATA[75]]></departmentCode>
    <departmentName><![CDATA[Paris]]></departmentName>
    <region><![CDATA[Centre-Val de Loire]]></region>
    <country><![CDATA[FR]]></country>
    <location>
      <lat><![CDATA[47.8951]]></lat>
      <lon><![CDATA[1.9108]]></lon>
    </location>
  </address>
  
  <address>
    <street><![CDATA[Port de Loire]]></street>
    <postalCode><![CDATA[45110]]></postalCode>
    <city><![CDATA[Châteauneuf-sur-Loire]]></city>
    <departmentCode><![CDATA[45]]></departmentCode>
    <departmentName><![CDATA[Loiret]]></departmentName>
    <region><![CDATA[Île-de-France]]></region>
    <country><![CDATA[FR]]></country>
    <location>
      <lat><![CDATA[48.8698]]></lat>
      <lon><![CDATA[2.3322]]></lon>
    </location>
  </address>
  
  <address>
    <street><![CDATA[20 rue Victor Hugo]]></street>
    <postalCode><![CDATA[59000]]></postalCode>
    <city><![CDATA[Lille]]></city>
    <departmentCode><![CDATA[59]]></departmentCode>
    <departmentName><![CDATA[Nord]]></departmentName>
    <region><![CDATA[Hauts-de-France]]></region>
    <country><![CDATA[FR]]></country>
  </address>
</addresses>
Nom du champ
Type
Description

addresses

Address[]

Tableau des adresses où se déroule la mission. Chaque objet représente une adresse distincte. Veuillez vous référer au tableau ci-dessous ⬇️

Une adresse se compose des champs suivants :

Nom du champs
Type
Description

street

String

Rue où se déroule la mission. Exemple: 46 Rue Saint-Antoine

postalCode

String

Code postal où se déroule la mission Exemple: 75004

city

String

Ville où se déroule la mission Exemple: Paris

departmentCode

String

Numéro de département où se déroule la mission. Exemple: 75

departmentName

String

Nom du département où se déroule la mission

region

String

Région où se déroule la mission

country

String

location

{lat:number;lon:number}

Champs de l'organisation ou de la structure d'accueil

Nom du champs
Type
Description

organizationName

String

Nom de l'organisation de la mission

organizationRNA

String

RNA de l'organisation de la mission Requis (ou organizationSiren)

organizationSiren

String

Siren de l'organisation de la mission Requis (ou organizationRNA)

organizationUrl

String

Lien de l'organisation de la mission.

Il peut s'agir de la page de présentation de l'organisation sur votre site par exemple.

organizationLogo

String

Lien de l'image de l'organisation de la mission

organizationDescription

String

Description de l'organisation de la mission

organizationClientId

String

Identifiant de l'organisation de la mission

organizationStatusJuridique

String

Statut juridique de l'organisation de la mission

organizationType

String

Type de l'organisation de la mission Exemple 1: "Association déclarée" Exemple 2: "Association internationale"

organizationActions

String[]

Actions de l'organisation de la mission Exemple : "Animation, Valorisation, Préservation"

organizationId

String

Identifiant de l'organisation de la mission

organizationFullAddress

String

Adresse de l'organisation de la mission

organizationPostCode

String

Code postal de l'organisation de la mission

organizationCity

String

Ville de l'organisation de la mission

organizationBeneficiaries

String[]

Bénéficiaires de l'organisation de la mission

organizationReseaux

String[]

Réseau de l'organisation de la mission

PreviousFormat du flux XMLNextConditions d'utilisation du flux XML

Last updated 2 months ago

du pays de la mission Défaut FR

Composé de lat et lon de type Number représentant la latitude et longitude de l'adresse de la mission Si la longitude et la latitude ne sont pas fournies ou sont incorrectes, l'API utilise l' pour obtenir ces valeurs. La mission est géolocalisée si au moins l'un des champs suivants est renseigné : adresse, ville ou code postal.

Code ISO 2
api-adresse