← Dokumentation·Sonstiges

API Mewayz Add-on

●  Aktualisiert Mai 2026Mewayz

API Mewayz Add-On

Discover the power of Mewayz’s API integration for seamless project and task management. Extend and customize with ease. Try now!

Demo-URL

Einführung

The API Docs Generator is a powerful Add-On that provides complete API documentation for the Mewayz platform. This Add-On helps developers and technical teams access detailed API information, including endpoints, headers, parameters, and response examples. The documentation covers 14 major modules of the platform and enables users to build custom applications, integrate external systems, or test APIs manually using tools like Postman.

How to enable this module

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

This comprehensive API documentation is your gateway to harnessing the power of Mewayz’s features, allowing you to streamline your work, boost productivity, and bring your projects to the next level.

This API documentation is a resource for developers, both seasoned and new, who want to leverage Mewayz’s capabilities within their applications. Here’s what you can expect to find.

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.

Request parameters are used to customize the behavior of your API requests and provide more specific details when interacting with the API. For Mewayz, you might have the following types of request parameters: Query Parameters to filter or sort data when retrieving information, Request Headers for authentication and additional metadata about the request, and Request Body containing JSON data to be created or updated.

Mewayz’s API typically responds with data in JSON format. The response typically includes an HTTP status code indicating the outcome of the request, and the actual data is contained within the „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]” and password like **“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 →