API REST

Obtenir la documentation de l’API

Swagger mis à disposition en remplacement de la documentation en ligne

Depuis la version 14.3 de Modulr, une documentation de l’API sous forme de Swagger est disponible. La documentation en ligne a été supprimée en version 14.6 car obsolète.

La documentation via Swagger présente plusieurs avantages. Notamment, elle est auto-générée à chaque nouvelle version de Modulr avec les éventuelles nouvelles routes et les éventuels nouveaux champs. De plus, elle précise pour chaque champ / paramètre s’il est obligatoire ou non, le type de donnée attendu, et s’il est accessible en lecture et/ou écriture.

Accéder au Swagger de documentation de l’API

Pour accéder au Swagger, vous devez :

Disposer d’un accès à Modulr. Si vous n’en avez pas, référez-vous à un contact / administrateur au sein de l’organisation du courtier utilisateur de Modulr afin qu’il vous fournisse le Swagger.
Avoir l’API activée sur le compte Modulr. Si ce n’est pas le cas, rapprochez vous du service commercial ECILIA.

Pour accéder au Swagger, une fois connecté à Modulr, rendez-vous dans le menu Panneau d'administration > Utilisateurs. Ici, les utilisateurs ayant l’API activée sont facilement identifiables par la présence de cette icône en bout de ligne :

En survolant cette icône, vous verrez 3 liens de téléchargement :

Routes d'authentification : Détail les routes pour s’authentifier en temps qu’utilisateur ou apporteur d’affaires.
Routes accessible en tant qu'utilisateur : Détail les routes accessibles aux utilisateurs.
Routes accessible en tant qu'apporteur d'affaires : Détail les routes accessibles aux apporteurs d’affaires.

Sauf cas exceptionnel, ce sont la plupart du temps les 2 premiers dont vous aurez besoin pour vous authentifier comme un utilisateur classique, puis pour effectuer des manipulations sur les fiches clients, devis, contrats, la GED, etc.

Créer un utilisateur API

Si aucun utilisateur n’a l’API activé, vous pouvez en créer un spécifiquement (sous réserve de licence disponible, au besoin, contactez le service commercial ECILIA).

Pour activer l’API sur un utilisateur, ouvrez ce dernier en modification puis activez l’option Utiliser les services web (API) comme sur la capture d'écran ci-dessous. Un mot de passe dédié à l’API s’affiche alors. Sauvegardez le précieusement / fournissez-le à votre prestataire, car il ne sera pas de nouveau récupérable. Il faudra désactiver l’option puis la réactiver pour un obtenir un nouveau.

Compléments d’informations

Limitation

L’API est limitée à 2 000 appels / 5 minutes / adresse IP.

Si cette limite est atteinte, l'appel à l’API retourne une erreur http 429 Too Many Requests avec dans le body « Too many request, retry after 5 minutes ».

L'IP en question est donc bloquée pendant 5 minutes. Si vous obtenez une erreur http 429 sur les appels API, il convient alors de gérer au niveau du code une attente de 5 minutes.

Authentification

Le jeton d'authentification a une durée de validité d'1 heure.