➜︎ Retour - Menu API, webhooks et mailhooks
OpenAPI et Postman
Menu de la documentation
Cette page propose deux fichiers à importer dans vos outils pour travailler avec l'API de Melkal : un fichier OpenAPI et une collection Postman. Réglage de l'API : Réglages → API & Make.
Ils décrivent les six routes de la version V1 (clients) : paramètres, corps des requêtes, formes des réponses et erreurs.
Ils sont à jour à la date indiquée en bas de cette page. En cas de doute, la documentation de ces pages fait foi.
Le fichier OpenAPI#
OpenAPI est le format standard de description d'une API. Un outil qui le lit sait quelles routes existent et quels paramètres envoyer.Télécharger le fichier OpenAPI (JSON)
Ce que vous pouvez en faire :
- Le lire et l'essayer dans Swagger Editor, Redoc ou Insomnia : importez le fichier.
- Générer le code d'un client dans votre langage (Java, C#, PHP, Python, TypeScript...) avec un générateur OpenAPI.
- Créer un connecteur dans un outil d'intégration qui accepte OpenAPI.
La collection Postman#
La collection contient un exemple de chaque requête, prêt à envoyer.Télécharger la collection Postman
- Dans Postman, cliquez sur Import et choisissez le fichier téléchargé.
- Ouvrez la collection « API Melkal V1 », onglet Variables.
- Renseignez adresse_api (votre adresse API, sans barre oblique finale) et cle_api (votre clé), puis enregistrez.
- Envoyez d'abord hello pour vérifier la connexion, puis les autres requêtes.
Attention aux requêtes de modification. « Créer un client » et « Modifier un client » écrivent dans votre base Melkal : essayez-les sur un client de test.
Les requêtes de lecture (hello, rechercher, lister) ne modifient rien.
Sans rien installer#
Les pages Démarrer, Rechercher un client et Lister les clients ont un cadre « Votre adresse API et votre clé » en haut : une fois renseigné, les boutons « Essayer » envoient la requête depuis votre navigateur, et les boutons « Copier » copient la requête avec votre adresse et votre clé.Dernière mise à jour : 13 octobre 2026