# API

Depuis la version 4.0, LdapSaisie offre une API visant à permettre de faire les mêmes choses que ce qu'il est possible d'accomplir via l'interface web. L'idée n'est bien entendue pas de se substituer systématiquement à la possibilité de se connecter directement à l'annuaire, mais plutôt d'offrir une API web pour l'intégration d'outil préférant ce mode d'interaction, ou encore, pour exposer des méthodes accès aux données de l'annuaire tout en profitant des logiques métiers implémentées/configurées dans LdapSaisie : validation syntaxique et d'unicité, règle de génération et d'interdépendances des attributs, déclencheurs, ...

Cette API est actuellement dans une phase de test et n'offre pas encore toutes les fonctionnalités proposées dans l'interface web. Elle est vouée à évoluer pour intégrer petit à petit un maximum de fonctionnalités. Des contributions à ce sujet seront plus qu'appréciée !

## Authentification

L'authentification à l'API utilise le même composant `LSauth` que lors d'une authentification à l'interface web, cependant, ce composant s'adapte pour prendre en compte de mode de connexion. Par défaut, la méthode d'authentification utilisée sera &LSauthMethod_HTTP; et permettra de se connecter en spécifiant le nom d'utilisateur et le mot de l'utilisateur cherchant à se connecter via une authentification basique HTTP.

Il est à noter que tous les types d'utilisateur ne peuvent pas forcément utiliser l'API : le paramètre `api_access` doit être explicitement positionné à `True` dans la configuration du serveur LDAP.

Une fois connecté, l'utilisateur endossera les droits associés à ses &LSprofiles;, tout comme un utilisateur connecté à l'interface web.

## Méthodes exposées

Les URLs des méthodes de l'API ont été construites par mimétisme sur celle de l'interface web et sous la racine web `api/`. Par ailleurs, un numéro de version d'API a été insérée dans chacune d'elles afin d'anticiper toutes évolutions futures majeures nécéssitants de conserver une rétrocompatibilité avec les anciennes versions de l'API.

Toutes les méthodes retournent des informations au format JSON et accepte le paramètre `pretty` permettant d'obtenir un retour plus facilement lisible. Les chaines de caractères échangées doivent par ailleurs être encodées en UTF-8. On trouvera par ailleurs dans le retour JSON :

success

  Booléen précisant si l'action demandée a correctement été exécutée.

messages

  Ce tableau pourra être présent et lister les messages d'informations générées par l'action demandée. Il s'agira des mêmes messages que ceux affichés dans l'interface web lorsque les actions équivalentes y sont faites.

errors

  Ce tableau pourra être présent et lister les messages d'erreurs générées par l'action demandée.

Les messages d'informations et d'erreurs générées par l'application sont traduites dans la langue courante qui peut être spécifiée via le paramètre `lang` accepté par toutes les méthodes (exemple : `fr_FR` ou `en_US`).

Lorsqu'une méthode cible un type d'objets, voir un objet en particulier, ces informations seront transmises dans l'URL appelée. Si le type d'objet ou l'objet demandé est introuvable, une erreur HTTP 404 sera générée.

Sauf précision contraire, toutes les méthodes exposées sont accessibles uniquement via les méthodes HTTP `GET` ou `POST`. L'accès via une autre méthode retournera une erreur 404.

### Liste des méthodes exposées

/api/1.0/object/[object type]

  Cette méthode permet de rechercher/lister les informations d'un type d'objets de l'annuaire en particulier. Le type de l'objet est précisé dans l'URL et doit être encodé en conséquence. Par mimétisme du comportement de l'interface web, la recherche est paginée et accepte des paramètres similaires en plus de paramètre plus appropriés à un fonctionnement programmatique :

  ### Paramètres acceptés

  filter

    Permet de spécifier un filtre de recherche LDAP personnalisé. Celui-ci sera combiné avec les paramètres propres au type d'objets recherchés et aux autres paramètres spécifiés (`pattern` par exemple).

    Du fait d'une limitation de la classe `Net_LDAP2_Filter` utilisée pour analyser le filtre passé en paramètre, seuls les filtres simples du type `(attribut=valeur)` sont acceptés ici. Pour les mêmes raisons, il est important que le filtre spécifié soit toujours entourné de paranthèses.

  predefinedFilter

    Permet de spécifier un des filtres de recherche LDAP prédéfinis dans la configuration du type d'objet.

  pattern

    Permet de spécifier un mot clé de recherche, comme proposé dans l'interface web.

  approx

    Booléen permettant d'activer/désactiver la recherche approximative sur le mot clé. Les valeurs acceptées sont `1` ou `0`.

  basedn

    Permet de spécifier une base de recherche personnalisé pour la recherche.

  subDn

    Dans le cas d'un serveur LDAP configuré avec des sous-niveaux de connexion, permet de spécifier le sous-niveau pour la recherche.

  scope

    Permet de spécifier l'étendue de la recherche dans l'annuaire. Valeurs acceptées: `sub`, `one` et `base`.

  recursive

    Booléen permettant d'activer/désactiver la recherche recursive, c'est à dire une recherche à la racine de l'annuaire (ou du sous-niveau de connexion) avec une étendue de recherche maximale. Les valeurs acceptées sont `1` ou `0`.

  displayFormat

    Permet de spécifier un &LSformat; personnalisé pour le nom des objets dans le résultat de recherche.

  extraDisplayedColumns

    Booléen permettant d'activer le retour des colonnes personnalisées dans le résultat de recherche. Les valeurs acceptées sont `1` ou `0`.

  attributes

    Liste des attributs supplémentaires que devra retourner la recherche.

  attributesDetails

    Permet d'obtenir les détails sur les valeurs des attributs (au lieu des valeurs au format attendu en cas de création/modification de l'objet). Seul la présence de ce paramètre suffit à activer ce comportement, sa valeur n'a pas d'importance.

  sortBy

    Permet de préciser sur quelle information le résultat de recherche doit être trié. Valeurs acceptées : `displayName`, `subDn` ou un des noms des colonnes personnalisées.

  sortDirection

    Permet de préciser l'ordre de tri du résultat de recherche. Valeurs acceptées : `ASC` (A-Z) ou `DESC` (Z-A).

  page

    Permet de préciser la page du résultat de recherche.

  nbObjectsByPage

    Permet de préciser le nombre maximum d'objets retournés par page du résultat de recherche.

  all

    Permet de réclamer le résultat complet de la recherche (désactivation de la pagination). Seul la présence de ce paramètre suffit à activer ce comportement, sa valeur n'a pas d'importance.

  as_list

    Permet de réclamer un résultat de recherche dans lequel, la clé `objects` sera une liste et non un dictionnaire. Dans ce cas, le DN de l'objet est fourni dans la clé `dn` des détails des objets.

  withoutCache

    Booléen permettant de désactiver l'utilisation du cache. Les valeurs acceptées sont `1` ou `0`.

  keepParamsBetweenSearches

    Booléen permettant d'activer/désactiver le stockage en session des paramètres de recherche (optionnel, par défaut : `Faux`). Les valeurs acceptées sont `1` ou `0`.

              Exemple
      # curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople?extraDisplayedColumns=1&pretty'
      {
          "success": true,
          "objects": {
              "uid=hmartin,ou=people,o=ls": {
                  "name": "Henri MARTIN",
                  "Mail": "henri.martin@ls.com"
              },
              "uid=s.ldapsaisie,ou=people,o=ls": {
                  "name": "Secretariat LdapSaisie",
                  "Mail": "secretariat@ldapsaisie.biz"
              },
              "uid=ls,ou=people,o=ls": {
                  "name": "LdapSaisie",
                  "Mail": "ldap.saisie@ls.com"
              },
              "uid=erwpa,ou=people,o=ls": {
                  "name": "Erwan PAGE",
                  "Mail": "erwan.page@ldapsaisie.biz"
              },
              "uid=user2,ou=people,ou=company1,ou=companies,o=ls": {
                  "name": "prenom2 nom2",
                  "Mail": "user2@ls.com"
              }
          },
          "total": 14,
          "params": {
              "keepParamsBetweenSearches": false,
              "filter": null,
              "pattern": null,
              "predefinedFilter": false,
              "basedn": null,
              "scope": null,
              "sizelimit": 0,
              "attronly": false,
              "approx": false,
              "recursive": true,
              "attributes": [],
              "onlyAccessible": true,
              "sortDirection": null,
              "sortBy": null,
              "sortlimit": 0,
              "displayFormat": "%{cn}",
              "nbObjectsByPage": 25,
              "withoutCache": false,
              "extraDisplayedColumns": true
          },
          "page": 1,
          "nbPages": 3
      }

/api/1.0/object/[object type]/[dn]

  Cette méthode permet de récupérer les informations d'un objet de l'annuaire au format JSON. Le type de l'objet et son DN sont précisés dans l'URL et doivent être encodés en conséquence. Par défaut, les valeurs des attributs retournées sont au format tel qu'attendu en cas de création/modification de l'objet. Il est cependant possible d'ajouter le paramètre `details` afin d'obtenir des informations complémentaires sur les valeurs des attributs.

              Exemple
      # curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/uid=hmartin,ou=people,o=ls?pretty'
      {
          "success": true,
          "dn": "uid=hmartin,ou=people,o=ls",
          "type": "LSpeople",
          "name": "Henri MARTIN",
          "details": false,
          "attributes": {
              "uid": "hmartin",
              "givenName": "Henri",
              "sn": "MARTIN",
              "cn": "Henri MARTIN",
              "mail": "henri.martin@ls.com",
              "personalTitle": "M.",
              "description": [],
              "jpegPhoto": null,
              "lsGodfatherDn": [
                  "uid=eeggs,ou=people,o=ls"
              ],
              "uidNumber": "101022",
              "gidNumber": "102001",
              "loginShell": "no",
              "homeDirectory": "\/home\/com",
              "gecos": null,
              "shadowExpire": null,
              "shadowMax": null,
              "shadowInactive": null,
              "shadowLastChange": null,
              "sambaSID": "S-1-5-21-2421470416-3566881284-3047381809-203044",
              "sambaPrimaryGroupSID": "S-1-5-21-2421470416-3566881284-3047381809-205003",
              "sambaAcctFlags": [
                  "U"
              ],
              "sambaHomeDrive": null,
              "sambaHomePath": null,
              "sambaProfilePath": null,
              "sambaLogonScript": null,
              "sambaLogonTime": null,
              "sambaLogoffTime": null,
              "sambaKickoffTime": null,
              "sambaPwdLastSet": null,
              "sambaPwdMustChange": null,
              "sambaPwdCanChange": null
          },
          "relations": {
              "groups": {
                  "cn=direction,ou=groups,o=ls": "direction",
                  "cn=secretariat,ou=groups,o=ls": "secretariat"
              },
              "godfather": []
          }
      }

/api/1.0/object/[object type]/create

  Cette méthode permet de créer un objet dans l'annuaire. Le type de l'objet qui sera créé est précisé dans l'URL et doit être encodé en conséquence. Les informations de l'objet doivent est transmises au format `x-www-form-urlencoded`. Elles peuvent également être au format `multipart/form-data`, en particulier si votre requête contient une image. Par mimétisme avec l'interface web, seuls les attributs prévus dans le formulaire de création du type d'objet peuvent être passées ici. De la même manière, les attributs non-spécifiés ici, pouront être auto-générés en accord avec leur configuration et la requête sera acceptée uniquement si tous les attributs obligatoires y sont spécifiés ou s'ils peuvent être auto-générés.

  Le format et la syntaxe des valeurs des attributs dépends de leur type HTML. Ainsi, par exemple, un attribut de type HTML `boolean` acceptera comme valeurs possibles `yes` ou `no`. Pour plus de détails sur le type de valeur acceptée par un type d'attribut HTML en particulier, consultez sa documentation. Vous pouvez également analyser le code de la méthode `getPostData()` de la classe PHP correspondante.

  Si l'application détecte un souci avec les informations transmises pour les attributs, un tableau `fields_errors` sera présent dans la réponse JSON et contiendra pour chacun des attributs problématique, un tableau des messages d'erreurs générées par l'application.

  Si le type d'objet en prévoit, vous pouvez également utiliser un masque de saisie via le paramètre `dataEntryForm`.

              Exemple
      # curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/create?pretty' -d "uid=foo.bar&personalTitle=M.&givenName=foo&sn=bar&cn=Foo Bar&mail=foo.bar@example.com&userPassword=Y0urS3cr3t&lsGodfatherDn[]=uid=admin,ou=people,o=ls&gidNumber=70000"
      {
          "success": true,
          "type": "LSpeople",
          "dn": "uid=foo.bar,ou=people,o=ls",
          "name": "Foo Bar",
          "messages": [
              "Le mail de notification a \u00e9t\u00e9 envoy\u00e9.",
              "L'objet a \u00e9t\u00e9 ajout\u00e9."
          ]
      }

/api/1.0/object/[object type]/[dn]/modify

  Cette méthode permet de modifier un objet dans l'annuaire. Le type de l'objet et son DN sont précisés dans l'URL et doivent être encodés en conséquence. Les informations de l'objet à modifier doivent être transmises au même format que pour la méthode `create` (voir ci-dessus). Comme pour cette dernière, seuls les attributs prévus dans le formulaire de modification du type d'objet peuvent être passées ici et la réponse JSON pourra contenir un tableau `fields_errors` contenant les erreurs générées par l'application au sujet des valeurs transmises pour les attributs.

              Exemple
      # curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/uid=foo.bar,ou=people,o=ls/modify?pretty' -d "givenName=foo&sn=bar&cn=Foo Bar"
      {
          "dn": "uid=foo.bar,ou=people,o=ls",
          "type": "LSpeople",
          "name": "Foo Bar",
          "success": true,
          "messages": [
              "L'objet a bien \u00e9t\u00e9 modifi\u00e9."
          ]
      }

/api/1.0/object/[object type]/[dn]/remove

  Cette méthode permet de supprimer un objet dans l'annuaire. Le type de l'objet et son DN sont précisés dans l'URL et doivent être encodés en conséquence.

              Exemple
      # curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/uid=foo.bar,ou=people,o=ls/remove?pretty'
      {
          "dn": "uid=foo.bar,ou=people,o=ls",
          "type": "LSpeople",
          "name": "Foo Bar",
          "success": true,
          "messages": [
              "Foo Bar a bien \u00e9t\u00e9 supprim\u00e9."
          ]
      }

/api/1.0/object/[object type]/import

  Cette méthode permet d'importer des objets d'un type en particulier à partir de données d'import formatées selon un &ioFormat; configuré pour ce type d'objets. Le type de l'objet est précisé dans l'URL et doit être encodé en conséquence. Par mimétisme du comportement de l'interface web, cette méthode accepte des paramètres similaires et s'attend à récupérer les données d'import dans le corps de la requête.

  ### Paramètres acceptés

  ioFormat

    Le nom de l'&ioFormat; des données d'import.

  updateIfExists

    Booléen permettant d'activer/désactiver la mise à jour des données des objets s'ils existent déjà. Si ce mode est inactif et qu'un objet des données d'import existe déjà, une erreur sera remontée. Les valeurs acceptées sont `1` ou `0`.

  justTry

    Booléen permettant d'activer/désactiver le mode de vérification des données d'import uniquement. Si ce mode est actif, les données d'import seront analysées pour vérifier qu'elles sont correctes, mais l'import en lui-même ne sera pas effectué. Les valeurs acceptées sont `1` ou `0`.

    Le retour de cette méthode en mode `justTry` est identique à une exécution en mode normal. Ce mode permet donc d'anticiper le résultat d'un import à partir d'un jeu de données sources.

    En mode `justTry`, seul la vérification syntaxique des données est fiable, car les informations doublonnées au sein des données d'import ne pourront être détectées.

  En cas d'erreurs détectées dans les informations des objets des données d'import, le tableau `errors` du retour de la méthode contiendra une entrée pour chaque objet en erreur sous le format d'un dictionnaire dont la clé `data` reprendra les informations de l'objet telle que chargé (ou générée) depuis les données sources, ainsi qu'un dictionnaire sous la clé `errors` qui contiendra les erreurs globales concernant l'objet sous la clé `globals` et les erreurs propres à ses attributs dans un dictionnaire sous la clé `attrs`.

  Les erreurs d'importation sur un objet sont non-bloquantes : l'importation des autres objets ne sera pas interrompue.

              Exemple
      # curl -u username:secret --data-binary @/path/to/input.file 'https://ldapsaisie/api/1.0/object/LSpeople/import?ioFormat=mycsv&pretty'
      {
          "success": false,
          "LSobject": "LSpeople",
          "ioFormat": "mycsv",
          "updateIfExists": false,
          "justTry": false,
          "imported": {
              "uid=rturin,ou=people,o=ls": "M. Roger TURIN"
          },
          "updated": [],
          "errors": [
              {
                  "data": {
                      "uid": [
                          "lmartin"
                      ],
                      "personalTitle": [
                          "Mme"
                      ],
                      "givenName": [
                          "Ludivine"
                      ],
                      "sn": [
                          "MARTIN"
                      ],
                      "mail": [
                          "lmartin@gmail.com"
                      ],
                      "userPassword": [
                          "123Yh%uT"
                      ],
                      "gidNumber": [
                          "102009"
                      ],
                      "loginShell": [
                          "no"
                      ],
                      "cn": [
                          "Mme Ludivine MARTIN"
                      ]
                  },
                  "errors": {
                      "globals": [
                          "Un objet existe d\u00e9j\u00e0 dans l'annuaire LDAP avec le DN uid=lmartin,ou=people,o=ls."
                      ],
                      "attrs": []
                  }
              }
          ],
          "messages": [
              "Le mail de notification a \u00e9t\u00e9 envoy\u00e9."
          ]
      }

/api/1.0/object/[object type]/export

  Cette méthode permet d'exporter les objets d'un type en particulier dans un &ioFormat; configuré pour ce type d'objets. Le type de l'objet est précisé dans l'URL et doit être encodé en conséquence.

  ### Paramètres acceptés

  ioFormat

    Le nom de l'&ioFormat;.

  En tant normal, le retour de cette méthode sera directement le fichier d'export demandé. Cependant, si une erreur survient, les paramètres d'export seront repris dans le retour `JSON` de la méthode qui contiendra également les erreurs survenues.

              Exemple
      # curl -u username:secret --data-binary @/path/to/input.file 'https://ldapsaisie/api/1.0/object/LSpeople/export?ioFormat=mycsv&pretty'
      login;civility;firstname;name;mail;password;gid;shell
      hmartin;M.;Henri;MARTIN;henri.martin@ls.com;********;102001;no
      s.ldapsaisie;M.;Secretariat;LdapSaisie;secretariat@ldapsaisie.biz;********;70000;no
      ls;M.;Ldap;Saisie;ldap.saisie@ls.com;********;102001;no
      erwpa;M.;Erwan;PAGEARD;erwan.page@ldapsaisie.biz;********;102009;no
      [...]

/api/1.0/object/[object type]/[dn]/relation/[relation]

  Cette méthode permet de gérer les objets en relation avec un objet en particulier de l'annuaire. Le type de l'objet, son DN et le nom de la relation sont précisés dans l'URL et doivent être encodés en conséquence. Cette méthode accepte les paramètres `add` et `remove` permettant de lister le ou les DN d'objet(s) à respectivement ajouter ou supprimer parmis les objets actuellement en relation avec l'objet spécifié. Si aucun DN n'est spécifié comme devant être ajouté ou supprimé, la méthode retournera simplement les DN des objets en relation. En cas de modification demandée, la méthode retournera la nouvelle liste des DNs des objets en relation, quel que soit le résultat de l'opération de mise à jour.

              Exemple
      # curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/uid=foo.bar,ou=people,o=ls/relation/groups?pretty&add[]=cn=ls,ou=groups,o=ls&add[]=cn=invite,ou=groups,o=ls'
      {
          "dn": "uid=foo.bar,ou=people,o=ls",
          "type": "LSpeople",
          "name": "Foo Bar",
          "relation": "groups",
          "success": true,
          "relatedObjects": [
              "cn=ls,ou=groups,o=ls",
              "cn=invite,ou=groups,o=ls"
          ],
          "messages": [
              "Objects in relation updated."
          ]
      }