Mise en œuvre de l’API Moduleo dans une application tierce

Mise en œuvre de l’API Moduleo dans une application tierce

Pour utiliser l’API Moduleo depuis une application tierce, il est nécessaire de mettre en œuvre certains éléments.

A qui est destiné cet article ?

Cet article est destiné aux éditeurs de logiciels et aux développeurs qui souhaitent connecter une application tierce à l’API Moduleo.

Prérequis

L’API Moduleo doit être activée sur le serveur Moduleo pour pouvoir être utilisée. L’API Moduleo sera disponible en version bêta à partir de juin 2021. Pour toute question concernant l’activation de l’API Moduleo, veuillez contacter l’équipe Kipaware.

La connexion à l’API Moduleo nécessite l’utilisation de clés d’API. La gestion des clés d’API se fait depuis le client Moduleo. L’article est disponible à https://support.kipaware.fr/moduleo/api-moduleo/fonctionnement-des-cles-d-api/.

Informations importantes

La description des méthodes d’API et le fichier de description WADL sont publiés directement par chaque serveur Moduleo.

Ces URLs, ainsi que l’adresse du serveur d’API et un lien vers la documentation en ligne sont accessibles depuis le client Moduleo via Administration => Licences et périphériques => Onglet Clés d’API Moduleo, puis via le bouton d’information.

Les parties floutées seront remplacées par l’adresse du serveur.

Protocole HTTPS

L’API Moduleo est accessible via le protocole HTTPS sur le port 443. Le chiffrement repose sur le protocole TLS 1.2.

Format des requêtes

Les requêtes échangées entre le client et le serveur d’API sont au format JSON.

Entête des requêtes authentifiées

La totalité des requêtes envoyées à l’API Moduleo doivent être authentifiées. Pour cela, les informations d’identification doivent être intégrées dans le Header :

  • Content-Type : format d’échange
    L’API Moduleo reconnaît uniquement le format JSON. Il faut donc habituellement spécifier “application/json”.
  • ApiKey : clé d’API Moduleo
  • SecurityCode : code de sécurité de la clé
    Si la clé d’API Moduleo impose une restriction par utilisateur, chaque utilisateur disposera de son propre code de sécurité. Sinon, le champ SecurityCode peut être omis ou laissé vide.

Exemple d’utilisation en langage Java :

HttpURLConnection con = (HttpURLConnection) url.openConnection();
con.setRequestProperty(“Content-Type”,”application/json”);
con.setRequestProperty(“ApiKey”, “132efs1f31zqe5rzq3f13zq1fz1f4h8r”);
con.setRequestProperty(“SecurityCode”,”1234AB”);

Sécurisation des clés d’API Moduleo

Pour des raisons de sécurité, les clés d’API Moduleo et leurs codes de sécurité ne doivent jamais être divulgués à des tiers.

Nous recommandons à tout développeur d’application tierce de mettre en œuvre des stratégies de sécurité adaptées lors du stockage et de la manipulation des clés d’API Moduleo et des codes de sécurité des utilisateurs. A minima, ces informations devront toujours être enregistrées sous un format chiffré.

Contactez-nous

Si vous ne trouvez pas la solution à votre problème, n'hésitez pas à nous contacter