API Mewayz Module complémentaire
Découvrez la puissance de l'intégration API de Mewayz pour une gestion fluide des projets et des tâches. Étendez et personnalisez en toute simplicité. Essayez maintenant !
Introduction
Le générateur de documentation d'API est un module complémentaire puissant qui fournit une documentation d'API complète pour la plateforme Mewayz. Ce module aide les développeurs et les équipes techniques à accéder à des informations détaillées sur l'API, notamment les points de terminaison, les en-têtes, les paramètres et des exemples de réponses. La documentation couvre 14 grands modules de la plateforme et permet aux utilisateurs de créer des applications sur mesure, d'intégrer des systèmes externes ou de tester les API manuellement à l'aide d'outils comme Postman.
Comment activer ce module
Pour configurer le module complémentaire API, suivez ce lien : Module complémentaire de configuration.
Comment utiliser le module complémentaire API ?
Générer la documentation de l'API
Après avoir acheté et installé cet add-on, allez dans la barre latérale de votre tableau de bord et recherchez l'add-on API Docs.
Pour accéder à la documentation de l'API, accédez à la section Documentation API depuis votre tableau de bord principal. La documentation est organisée par 14 modules, ce qui facilite la recherche des API spécifiques dont vous avez besoin pour votre projet d'intégration.
La section comprend une introduction générale qui explique comment utiliser efficacement les API. Cette présentation couvre les exigences d'authentification, les en-têtes courants et les principes d'utilisation de base qui s'appliquent à tous les points de terminaison de l'API.
Chaque module contient de puissantes listes d'API avec tous les détails techniques. Pour chaque point de terminaison d'API, vous trouverez le nom de l'API, l'URL exacte du point de terminaison, les en-têtes requis pour l'authentification et le format des données, les paramètres d'entrée avec leurs types de données et règles de validation, des exemples de réponses de succès illustrant la structure de données attendue, ainsi que des exemples de réponses d'erreur avec les codes et messages d'erreur courants.
Gestion de l'introduction
Cette documentation API complète est votre porte d'entrée pour exploiter toute la puissance des fonctionnalités de Mewayz, vous permettant de fluidifier votre travail, de booster votre productivité et de faire passer vos projets au niveau supérieur.
Cette documentation API est une ressource pour les développeurs, expérimentés comme débutants, qui souhaitent exploiter les capacités de Mewayz au sein de leurs applications. Voici ce que vous y trouverez.
Vous pouvez parcourir la référence complète et interactive dans le produit sous Paramètres → Docs API.
La section des endpoints couvre GET pour récupérer des données, POST pour créer de nouvelles données, POST pour mettre à jour des données existantes et DELETE pour supprimer des données. Vous pouvez utiliser des méthodes HTTP comme GET pour récupérer des données, POST pour créer de nouvelles données, POST pour mettre à jour des données existantes et DELETE pour supprimer des données.
Les paramètres de requête servent à personnaliser le comportement de vos requêtes API et à fournir des détails plus précis lors de l'interaction avec l'API. Pour Mewayz, vous pouvez disposer des types de paramètres de requête suivants : des paramètres de requête (query) pour filtrer ou trier les données lors de la récupération d'informations, des en-têtes de requête pour l'authentification et des métadonnées supplémentaires sur la requête, et un corps de requête contenant des données JSON à créer ou à mettre à jour.
L’API de Mewayz renvoie généralement des données au format JSON. La réponse comprend habituellement un code de statut HTTP indiquant le résultat de la requête, et les données elles-mêmes sont contenues dans le « data » champ.
Gestion de l'authentification
Les API d'authentification fournissent la fonctionnalité de connexion essentielle, les capacités de rafraîchissement de jeton pour maintenir les sessions, et les procédures de déconnexion pour mettre fin en toute sécurité aux sessions utilisateur.
Le point de terminaison de connexion POST /api/login requiert des en-têtes avec « Accepter »: « application/json » et des paramètres incluant l'e-mail tels que « [email protected] » et un mot de passe comme **« john**** »**.
Les réponses d'erreur renvoient un statut 422 Unprocessable Content avec « succès » : false, « message »: « Validation lorsque la validation est une erreur.
Les réponses d'erreur renvoient 400 Unauthorized avec « succès » : false, « message »: « Le fourni » lorsque les identifiants sont invalides.
Les réponses de connexion réussies renvoient 200 OK avec « succès »: true et une autorisation contenant le jeton et le type « bearer » pour les appels API suivants.
Le point de terminaison de rafraîchissement d'authentification POST /api/refresh utilise des en-têtes d'autorisation avec un jeton Bearer pour la gestion de session.
Les réponses de rafraîchissement réussies renvoient des informations utilisateur détaillées, dont 200 OK avec « succès »: true, ainsi que les détails de l'utilisateur, id, name, email, mobile_no, type : « entreprise », avatar : « URL », langue : « en » et le jeton.
Gestion des utilisateurs
- API utilisateur pour l'administration des utilisateurs, la gestion des rôles et les profils
opérations.
Gestion d'entrepôt
- API d'entrepôt pour la configuration d'entrepôt et les transferts entre entrepôts
gestion.
Gestion des produits et services
- Les API de la section Produits et Services gèrent les catégories de produits, les taxes,
unités de mesure, produits et gestion des stocks avec intégration de l'entrepôt.
Gestion des factures d'achat
- API de factures d'achat pour Liste, Création, Détail des factures d'achat,
Gestion de la mise à jour, de la suppression et de la publication des factures.
Gestion des retours d'achat
- Des API pour gérer la Liste des retours d'achat, la Création, le Détail du retour,
Supprimer, Approuver, Terminer le traitement.
Gestion des propositions commerciales
- API de propositions commerciales pour la gestion et la conversion des propositions
processus.
Gestion des factures de vente
- Les API de factures de vente gèrent la liste, la création, la mise à jour, la suppression des factures,
Gestion des factures comptabilisées.
Gestion des retours de factures de vente
- API pour gérer la liste, la création, le détail et la suppression des retours de factures de vente,
Approuver et terminer.
Gestion des comptes
- Les API de la section Compte vous permettent de gérer les clients, les fournisseurs,
- Le module Compte inclut des API de liste rapide pour récupérer de simples
Comptes bancaires, plan comptable, produits, dépenses, avoirs, notes de débit, paiements fournisseurs, paiements clients, transaction bancaire, virements bancaires. Vous pouvez effectuer des opérations telles que lister les enregistrements, créer de nouvelles entrées, consulter les détails, mettre à jour les informations et supprimer des enregistrements selon vos besoins.
les listes de clients et de fournisseurs, la liste des comptes du grand livre, ainsi que les catégories de revenus et de dépenses pour les sélections déroulantes et les références rapides.
Gestion de projet
- Les API de la section Projet gèrent les projets, les tâches, les bugs, les jalons,
fichiers et divers rapports avec leurs étapes et flux de travail associés.
Gestion du point de vente
- Les API de point de vente gèrent les opérations de caisse, notamment la gestion des commandes
et les détails de la commande.
Gestion CRM
- Les API de la section CRM couvrent la gestion du pipeline, les étapes des prospects et des affaires,
étiquettes, sources et gestion complète des prospects et des affaires. Vous pouvez gérer les tâches, les utilisateurs, les produits, les sources, les e-mails, les discussions, les fichiers et les appels associés à la fois aux prospects et aux affaires.
Gestion RH
- Les API de GRH gèrent la gestion des employés, la structure organisationnelle,
suivi des présences, gestion des congés, traitement de la paie et divers dossiers RH dont Récompenses, Promotions, Démissions, Licenciements, Avertissements, Réclamations, Transferts d'employés, jours fériés, événements, documents, Annonces et Accusés de réception.
Chaque point de terminaison API de la documentation inclut des exemples pratiques que vous pouvez copier et utiliser directement dans votre environnement de développement ou vos outils de test. Les exemples de réponses montrent à la fois les opérations réussies et les scénarios d'erreur courants, vous aidant à mettre en œuvre une gestion appropriée des erreurs dans vos applications.
Liste des API du module Wise :
- Authentification :
- Connexion
- Rafraîchissement du jeton
- Déconnexion
- Utilisateur :
- Utilisateur : Lister, Créer, Mettre à jour, Supprimer,
- Rôle : Liste
- Journal des utilisateurs : Liste
- Utilisateurs du personnel : Liste
- Utilisateurs clients : Liste
- Utilisateurs fournisseurs : Liste
- Entrepôt :
Mise à jour du profil, mise à jour du mot de passe, réinitialisation du mot de passe, vérification
- Entrepôt : Lister, Créer, Détailler, Mettre à jour,
- Virement : Lister, Créer des données de requête,
- Produit et service :
Supprimer
Créer, Supprimer
- Catégorie de produit : Lister, Créer, Mettre à jour,
- Taxe : Lister, Créer, Mettre à jour, Supprimer
- Unité : Lister, Créer, Mettre à jour, Supprimer
- Produit : Lister, Créer, Détailler, Mettre à jour,
- Stock du produit : Liste, Ajouter
- Produit en entrepôt : Liste
- Facture d'achat :
Supprimer
Supprimer
- Facture : Lister, Créer, Détailler, Mettre à jour,
- Retour d'achat :
Supprimer, Publier
- Retour : Liste, Création, Détail, Suppression,
- Proposition commerciale :
Approuver, Terminer
- Proposition : Lister, Créer, Détailler, Mettre à jour,
- Facture de vente :
Supprimer, Envoyé, Accepter, Refuser, Convertir en facture
- Facture : Lister, Créer, Détailler, Mettre à jour,
- Retour de facture de vente :
Supprimer, Publier
- Retour : Liste, Création, Détail, Suppression,
- Compte :
Approuver, Terminer
- Obtenir des clients : Liste de clients simple
- Obtenir les fournisseurs : Simple liste de fournisseurs
- Client : Lister, Créer, Mettre à jour, Supprimer
- Fournisseur : Lister, Créer, Mettre à jour, Supprimer
- Compte du grand livre : Liste
- Compte bancaire : Lister, Créer, Mettre à jour, Supprimer
- Catégories de revenus : Liste
- Chiffre d'affaires : Lister, Créer, Mettre à jour, Supprimer,
- Catégories de dépenses : Liste
- Dépense : Lister, Créer, Mettre à jour, Supprimer,
- Types de comptes : Liste
- Plan comptable : Liste
- Transaction bancaire : Liste
- Virement bancaire : Liste
- Paiements aux fournisseurs : Liste
- Paiements clients : Liste
- Avoir : Liste
- Note de débit : Liste
- Projet :
Approuver, Comptabiliser
Approuver, Comptabiliser
- Projet : Lister, Créer, Détailler, Mettre à jour,
- Membre du projet : Supprimer
- Client du projet : Lister, Inviter, Supprimer
- Jalon du projet : Lister, Créer, Mettre à jour,
- Fichier du projet : Créer, Supprimer
- Tâche : Tableau des tâches, Créer, Détail, Mettre à jour,
- Commentaire de tâche : Créer, Supprimer
- Sous-tâche : Créer, Mettre à jour
- Statut du bug : Liste
- Bug : Lister, Créer, Détailler, Mettre à jour, Supprimer
- Commentaire du bug : Créer, Supprimer
- Rapport de projet : Liste, Détail
- Étape de la tâche : Lister, Commander, Créer, Mettre à jour,
- Étape du bug : Lister, Commander, Créer, Mettre à jour,
- POS :
Supprimer
Supprimer
Supprimer
Supprimer
Supprimer
- Commande : Liste, Détail
- CRM :
- Pipeline : Lister, Créer, Mettre à jour, Supprimer
- Étape du prospect : Lister, Créer, Mettre à jour, Supprimer
- Étape de l'affaire : Lister, Créer, Mettre à jour, Supprimer
- Étiquettes : Lister, Créer, Mettre à jour, Supprimer
- Sources : Lister, Créer, Mettre à jour, Supprimer
- Prospect : Lister, Créer, Détailler, Mettre à jour,
- Tâche du prospect : Créer, mettre à jour, supprimer
- Utilisateur principal : Créer, Supprimer
- Produit phare : Créer, Supprimer
- Source du prospect : Créer, Supprimer
- E-mail du prospect : Créer
- Discussion sur le prospect : Créer
- Fichier de prospect : Créer, Supprimer
- Appel de prospection : Créer, mettre à jour, supprimer
- Affaire : Lister, Créer, Détailler, Mettre à jour,
- Tâche d'affaire : Créer, mettre à jour, supprimer
- Utilisateur de l'affaire : Créer, Supprimer
- Produit du contrat : Créer, Supprimer
- Source de l'opportunité : Créer, Supprimer
- E-mail de l'affaire : Créer
- Discussion du deal : Créer
- Fichier de l'affaire : Créer, Supprimer
- Client de l'affaire : Créer, Supprimer
- Appel d'affaire : Créer, mettre à jour, supprimer
- HRM :
Supprimer, Ajouter un label, Convertir en affaire
Supprimer, Ajouter une étiquette
- Employé : Lister, Créer, Détailler, Mettre à jour,
- Présence : Lister, Créer, Mettre à jour, Supprimer
- Types de congés : Liste
- Demandes de congé : Lister, Créer, Mettre à jour,
- Soldes de congés : Vérifier
- Paie : Liste, Détail
- Fiche de paie : Générer
- Équipes : Liste
- Succursales : Liste
- Services : Liste
- Désignations : Liste
- Types de documents : Liste
- Jours fériés : Liste
- Récompenses : Liste
- Promotions : Liste
- Démissions : Liste
- Départs : Liste
- Avertissements : Liste
- Réclamations : Liste
- Transferts d'employés : Liste
- Documents : Liste
- Remerciements : Liste
- Annonces : Liste
- Événements : Liste
Supprimer
Supprimer, Mettre à jour le statut