← Dokumentation·Sonstiges

API Mewayz Add-on

●  Aktualisiert Mai 2026Mewayz

API Mewayz Add-On

Entdecken Sie die Leistungsfähigkeit der API-Integration von Mewayz für eine nahtlose Projekt- und Aufgabenverwaltung. Mit Leichtigkeit erweitern und anpassen. Probieren Sie es jetzt aus!

Demo-URL

Einführung

Der API Docs Generator ist ein leistungsstarkes Add-On, das eine vollständige API-Dokumentation für die Mewayz-Plattform bereitstellt. Dieses Add-On hilft Entwicklern und technischen Teams beim Zugriff auf detaillierte API-Informationen, einschließlich Endpunkten, Headern, Parametern und Antwortbeispielen. Die Dokumentation deckt 14 Hauptmodule der Plattform ab und ermöglicht Benutzern das Erstellen benutzerdefinierter Anwendungen, die Integration externer Systeme oder das manuelle Testen von APIs mithilfe von Tools wie Postman.

So aktivieren Sie dieses Modul

Um das API-Add-On einzurichten, können Sie diesem Link folgen: Einrichtungs-Add-on.

Wie verwendet man das API-Add-on?

API-Dokumentation generieren

Nachdem Sie dieses Add-on gekauft und installiert haben, gehen Sie zur Seitenleiste Ihres Dashboards und suchen Sie nach dem API-Docs-Add-on.

Um auf die API-Dokumentation zuzugreifen, navigieren Sie über Ihr Haupt-Dashboard zum Bereich „API-Docs“. Die Dokumentation ist gegliedert nach 14 Module, sodass Sie die spezifischen APIs, die Sie für Ihr Integrationsprojekt benötigen, leicht finden.

Der Abschnitt enthält eine allgemeine Einführung, die erklärt, wie die APIs effektiv genutzt werden. Dieser Überblick behandelt Authentifizierungsanforderungen, gängige Header und grundlegende Nutzungsrichtlinien, die für alle API-Endpunkte gelten.

Jedes Modul enthält leistungsstarke API-Auflistungen mit vollständigen technischen Details. Für jeden API-Endpunkt finden Sie den API-Namen, die exakte Endpunkt-URL, die für Authentifizierung und Datenformat erforderlichen Header, Eingabeparameter mit ihren Datentypen und Validierungsregeln, Beispiel-Erfolgsantworten mit der erwarteten Datenstruktur sowie Beispiel-Fehlerantworten mit gängigen Fehlercodes und -meldungen.

Einführungsverwaltung

Diese umfassende API-Dokumentation ist Ihr Einstieg in die Nutzung der leistungsstarken Funktionen von Mewayz, sodass Sie Ihre Arbeit rationalisieren, die Produktivität steigern und Ihre Projekte auf die nächste Stufe bringen können.

Diese API-Dokumentation ist eine Ressource für erfahrene und neue Entwickler, die die Funktionen von Mewayz in ihren Anwendungen nutzen möchten. Folgendes können Sie erwarten.

Die vollständige, interaktive Referenz können Sie im Produkt durchsuchen unter Einstellungen → API-Docs.

Der Abschnitt Endpunkte deckt GET zum Abrufen von Daten, POST zum Erstellen neuer Daten, POST zum Aktualisieren bestehender Daten und DELETE zum Entfernen von Daten ab. Sie können HTTP-Methoden wie GET zum Abrufen von Daten, POST zum Erstellen neuer Daten, POST zum Aktualisieren bestehender Daten und DELETE zum Entfernen von Daten verwenden.

Anforderungsparameter werden verwendet, um das Verhalten Ihrer API-Anfragen anzupassen und spezifischere Details bei der Interaktion mit der API bereitzustellen. Für Mewayz verfügen Sie möglicherweise über die folgenden Arten von Anforderungsparametern: Abfrageparameter zum Filtern oder Sortieren von Daten beim Abrufen von Informationen, Anforderungsheader für die Authentifizierung und zusätzliche Metadaten zur Anforderung sowie Anforderungstext mit zu erstellenden oder zu aktualisierenden JSON-Daten.

Die API von Mewayz antwortet normalerweise mit Daten im JSON-Format. Die Antwort enthält normalerweise einen HTTP-Statuscode, der das Ergebnis der Anfrage angibt, und die tatsächlichen Daten sind darin enthalten „data“ Feld.

Authentifizierungsverwaltung

Authentifizierungs-APIs bieten die wesentliche Login-Funktionalität, Token-Refresh-Fähigkeiten zur Aufrechterhaltung von Sitzungen und Logout-Verfahren zum sicheren Beenden von Benutzersitzungen.

Der Login-Endpunkt POST /api/login erfordert Header mit „Annehmen“: „application/json“ und Parameter wie E-Mail, etwa „[email protected]“ und ein Passwort wie **„john****“**.

Fehlerantworten geben 422 Unprocessable Content zurück mit „success“: false, „Nachricht“: „Validierung, wenn die Validierung ein Fehler ist.

Fehlerantworten geben 400 Unauthorized zurück mit „success“: false, „Nachricht“: „Die bereitgestellte“ wenn die Anmeldedaten ungültig sind.

Erfolgreiche Login-Antworten geben 200 OK zurück mit „success“: true und Autorisierung mit Token und Typ „bearer“ für nachfolgende API-Aufrufe.

Der Auth-Refresh-Endpunkt POST /api/refresh verwendet Autorisierungs-Header mit einem Bearer-Token für das Sitzungsmanagement.

Erfolgreiche Refresh-Antworten geben detaillierte Nutzerinformationen zurück, darunter 200 OK mit „success“: true, und Nutzerdetails, id, name, email, mobile_no, type: „Unternehmen“, Avatar: „URL“, Sprache: „en“ und Token.

Nutzerverwaltung

Lagerverwaltung

Produkt- & Service-Management

Einkaufsrechnungs-Verwaltung

Verwaltung von Einkaufsrücksendungen

Verwaltung von Verkaufsangeboten

Verkaufsrechnungsverwaltung

Verwaltung von Verkaufsrechnungs-Retouren

Kontoverwaltung

Projektmanagement

POS-Verwaltung

CRM-Verwaltung

HRM-Verwaltung

Jeder API-Endpunkt in der Dokumentation enthält praktische Beispiele, die Sie kopieren und direkt in Ihrer Entwicklungsumgebung oder Ihren Testwerkzeugen verwenden können. Die Antwortbeispiele zeigen sowohl erfolgreiche Vorgänge als auch häufige Fehlerszenarien und helfen Ihnen, eine korrekte Fehlerbehandlung in Ihren Anwendungen umzusetzen.

Modulbezogene API-Liste:

War das hilfreich?
← Alle DocsFragen Sie das TeamKostenlos testen →