Ressources Humaines

API

Consulter la référence interactive de l'API de l'application RH : types de document et méthodes, dont l'enregistrement des pointages.

Cette page affiche la référence interactive de l'API de l'application RH (HRMS). Elle couvre les types de document des modules RH : employés, recrutement, quarts et présences, congés, notes de frais, évaluations et paie.

L'application mobile RH utilise aussi les méthodes du module hrms.api. Pour la présentation de l'application, voir Bienvenue.

Ce que contient la référence

La référence est générée par le site de démonstration à partir du code de l'application. Elle contient deux familles de points d'accès :

/api/resource/<Type de document> : lister, créer, lire, modifier et supprimer les documents d'un type. Les tables enfants n'ont pas de point d'accès propre : elles sont lues et écrites avec leur document parent.
/api/method/<chemin.de.la.méthode> : appeler une méthode Python ouverte à l'API (décorée par @frappe.whitelist).

La référence est en lecture seule : les boutons Authorize et Try it out sont masqués. Utilisez le champ de filtre pour chercher un point d'accès.

Enregistrer un pointage depuis une pointeuse

La méthode hrms.hr.doctype.employee_checkin.employee_checkin.add_log_based_on_employee_field crée un pointage d'employé. Elle accepte seulement la méthode HTTP POST. Elle cherche l'employé par un champ de sa fiche : par défaut l'ID de pointeuse (attendance_device_id). Les paramètres obligatoires sont employee_field_value et timestamp. Les paramètres facultatifs sont device_id, log_type (IN ou OUT), skip_auto_attendance, employee_fieldname, latitude et longitude.

S'authentifier

Chaque appel s'authentifie avec les clés d'API d'un utilisateur, dans l'en-tête Authorization: token <api_key>:<api_secret>. L'API applique les droits de cet utilisateur. Pour générer les clés et connaître les principes de l'API, voir API Rest et API REST v2.

Exemple fictif

La pointeuse de l'accueil envoie l'entrée de l'employé dont l'ID de pointeuse est 1042 :

curl -X POST "https://mappemonde.example.com/api/method/hrms.hr.doctype.employee_checkin.employee_checkin.add_log_based_on_employee_field" \
  -H "Authorization: token 1a2b3c4d5e6f7a8:9f8e7d6c5b4a3f2" \
  -d "employee_field_value=1042" \
  -d "timestamp=2026-11-04 08:57:00" \
  -d "device_id=Accueil" \
  -d "log_type=IN"