Intégration du bouton de candidature

Pour permettre aux internautes (futurs candidats) de naviguer jusqu'au formulaire de candidature vous devrez ajouter un lien sous forme de bouton sur les pages de votre site internet.

L’affichage du bouton de candidature devra être programmé par le webmaster gérant le site.
(Si vous n'en disposez pas, nous pouvons vous faire une proposition pour effectuer cette intégration.)

Dans l'idéal:

  • Le bouton de candidature devra être affiché sur les pages des biens en location avec un intitulé clair tel que « Déposer ma candidature en ligne » et être mis en avant.
  • Il ne devrait être affiché que s’il est possible de candidater pour la location concernée.
  • Il devrait mener directement vers le formulaire concernant le bien.

Pour permettre l'intégration dans la majeure partie des cas de figure techniques, nous vous proposons trois méthodes pour intégrer ce bouton.

Méthode 1 : Bouton ciblant un bien et affiché dynamiquement

Cette méthode est celle qui permet un fonctionnement idéal de nos services et qui fournira la meilleure expérience aux internautes candidats.

Afin de savoir s’il est possible de déposer un dossier de candidature pour un bien et donc si le bouton doit ou non être affiché, nous mettons à votre disposition une adresse de notre API.
Celle-ci est de la forme :

https://<votre_agence>.candidature-location.com/b/api/v1/biens/is_active/<reference>/

La valeur de <votre_agence> vous sera communiquée après mise en fonction de votre service.
La valeur de <référence> est la référence exacte du bien tel que saisi ou importé dans Clac.
Attention de bien finir l'URL par un slash final pour éviter les redirections.

pour exemple, si le sous-domaine assigné à votre agence est bestagence et que vous interrogez notre api pour le bien dont la référence est best-a-222 :
https://bestagence.candidature-location.com/b/api/v1/biens/is_active/best-a-222/

NOTE: Ces requêtes peuvent être soumises à un « rate limit » en cas de trafic trop élevé. (Le statut 429 sera alors renvoyé en réponse.) Il est donc préférable (dans la mesure du possible) d’effectuer ces requêtes côté serveur et de les mettre en cache pour une durée de 5mn à 10mn.

La réponse à la requête effectuée peut avoir deux statuts normaux : 200 ou 404.

Le statut 200 indique qu’il est possible de candidater pour le bien et qu’il faut donc afficher le bouton. La réponse contient l’URL que devra contenir le paramètre HREF du bouton.

{
    "detail": "Found.",
    "url_de_depot": "http://...",
    "saturated": false
}

Le statut 404 indique qu’il n’est pas possible de candidater et qu’il ne faut donc pas afficher le bouton.

{
    "detail": "Not found."
}

Précisions pour le champ saturated

Clac permet de configurer un quota de dossiers par bien. Si ce quota est configuré et que le nombre de dossiers déjà déposés pour un bien dépasse celui-ci, il devient alors impossible pour les candidats de déposer un dossier pour ce bien. Clac affiche alors un message informatif sur la page accessible par url_de_depot ainsi que sur la page listing des biens. Ce message invite le candidat à revenir plus tard ou à candidater pour un autre bien.

Le champ booléen saturated permets de savoir si le quota est dépassé, l’agence peut ainsi vouloir soit ne pas afficher le bouton de candidature, soit afficher sur son site l’information de dépassement de quota. Il est aussi possible d’ignorer cette information puisque Clac informera le candidat sur la page de dépôt.

Le champ saturated sera disponible à partir du 3 février 2022.

Méthode 2 : Bouton ciblant un bien et systématiquement affiché

Cette méthode ne nécessite pas de requête à notre api, mais est moins agréable pour les internautes, car au lieu de mener à coup sûr au formulaire de dépôt de candidature, elle peut mener à une page annonçant que le bien concerné n’est pas disponible. En effet, un bien peut exister sur le site internet de l’agence, mais peut ne pas être présent dans la base de données de Clac ou être dans un état qui rend le dépôt de candidature impossible. La méthode 1 est à préférer pour un meilleur service aux internautes.

Cette méthode nécessite simplement qu'un bouton soit affiché sur chaque page de bien en location avec pour seule variable la référence du bien.

Voici la forme de l'URL de ce bouton:

https://<votre_agence>.candidature-location.com/enter/<reference>

Dans ce cas de figure, notez qu'il ne faut pas de slash final.

Exemple d'un lien menant à la candidature en ligne pour un bien dont la référence serait b302 et dont le sous-domaine assigné pour l’agence serait agenceparis :
https://agenceparis.candidature-location.com/enter/b302

Méthode 3 : Bouton menant au listing des biens présent sur Clac et systématiquement affiché.

Cette méthode est la plus simple, mais est aussi celle qui est la moins confortable pour les internautes.

Le bouton est toujours affiché et mène au listing des biens sur Clac. Cela force l’internaute à rechercher une nouvelle fois le bien qui l’intéresse. De plus si le dépôt de candidature n’est pas possible pour ce bien, sa recherche ne sera pas satisfaite puisque le bien concerné ne se trouvera pas dans la liste.

Voici la forme du lien en question :

https://<votre_agence>.candidature-location.com/biens

Exemple d'un lien pour une agence à laquelle nos services auraient assigné le sous-domaine immo-du-futur :
https://immo-du-futur.candidature-location.com/biens