← ドキュメント·その他

API mewayz アドオン

●  2026 年 5 月更新Mewayz

API Mewayz アドオン

シームレスなプロジェクトとタスク管理のための Mewayz の API 統合の力を実感してください。簡単に拡張およびカスタマイズできます。今すぐ試してください!

デモURL

はじめに

API Docs Generator は、Mewayz プラットフォーム用の完全な API ドキュメントを提供する強力なアドオンです。このアドオンは、開発者や技術チームがエンドポイント、ヘッダー、パラメータ、応答例などの詳細な API 情報にアクセスするのに役立ちます。このドキュメントではプラットフォームの 14 の主要モジュールをカバーしており、ユーザーはカスタム アプリケーションを構築したり、外部システムを統合したり、Postman などのツールを使用して API を手動でテストしたりすることができます。

このモジュールを有効にする方法

API アドオンをセットアップするには、次のリンクをクリックします。 アドオンをセットアップします。

API アドオンの使用方法は?

API ドキュメントの生成

このアドオンを購入してインストールした後、ダッシュボードのサイドバーに移動して API Docs アドオンを検索します。

API ドキュメントにアクセスするには、メイン ダッシュボードから [Api ドキュメント] セクションに移動します。ドキュメントは次のように整理されています。 14モジュールにより、統合プロジェクトに必要な特定の API を簡単に見つけることができます。

このセクションには、API を効果的に使用する方法を説明する一般的な概要が含まれています。この概要では、認証要件、共通ヘッダー、およびすべての API エンドポイントに適用される基本的な使用ガイドラインについて説明します。

各モジュールには、完全な技術詳細を含む強力な API リストが含まれています。すべての API エンドポイントについて、API 名、正確なエンドポイント URL、認証とデータ形式に必要なヘッダー、入力パラメーターとそのデータ型と検証ルール、予想されるデータ構造を示す成功応答の例、および一般的なエラー コードとメッセージを含むエラー応答の例が見つかります。

導入管理

この包括的な API ドキュメントは、Mewayz の機能を活用するためのゲートウェイであり、作業を合理化し、生産性を向上させ、プロジェクトを次のレベルに引き上げることができます。

この API ドキュメントは、アプリケーション内で Mewayz の機能を活用したいと考えている、経験豊富な開発者と新しい開発者を対象としたリソースです。期待できる内容は次のとおりです。

製品内の完全なインタラクティブなリファレンスは、以下で参照できます。 設定 → API ドキュメント。

エンドポイントのセクションでは、データを取得する GET、新しいデータを作成する POST、既存のデータを更新する POST、データを削除する DELETE について説明します。 GET などの HTTP メソッドを使用してデータを取得し、POST を使用して新しいデータを作成し、POST を使用して既存のデータを更新し、DELETE を使用してデータを削除できます。

リクエスト パラメーターは、API リクエストの動作をカスタマイズし、API と対話するときにより具体的な詳細を提供するために使用されます。 Mewayz の場合、次のタイプのリクエスト パラメータがある可能性があります: 情報を取得するときにデータをフィルタリングまたは並べ替えるためのクエリ パラメータ、認証およびリクエストに関する追加のメタデータ用のリクエスト ヘッダー、作成または更新される JSON データを含むリクエスト本文。

Mewayz の API は通常、JSON 形式のデータで応答します。通常、応答にはリクエストの結果を示す HTTP ステータス コードが含まれており、実際のデータは 「データ」 フィールド。

認証管理

認証 API は、必須のログイン機能、セッションを維持するためのトークン更新機能、ユーザー セッションを安全に終了するためのログアウト手順を提供します。

ログイン エンドポイント POST /api/login には次のヘッダーが必要です 「受け入れます」: 「アプリケーション/json」 およびパラメータには次のような電子メールが含まれます 「[email protected]」 パスワードは **「john****」** などです。

エラー応答は 422 Unprocessable Content を返します。 「成功」: 偽、 「メッセージ」: 「バリデーション バリデーションがエラーとなった場合。

エラー応答は 400 Unauthorized を返します 「成功」: 偽、 「メッセージ」: 「提供されたもの」 資格情報が無効な場合。

成功したログイン応答は 200 OK を返します。 「成功」: true およびトークンとタイプを含む認可 「担ぎ手」 後続の API 呼び出し用。

認証リフレッシュ エンドポイント POST /api/refresh は、セッション管理にベアラー トークンを含む認証ヘッダーを使用します。

更新応答が成功すると、200 OK などの詳細なユーザー情報が返されます。 「成功」: true、ユーザーの詳細、ID、名前、電子メール、mobile_no、タイプ: 「会社」、アバター: 「URL」、言語: 「えん」 そしてトークン。

ユーザー管理

Warehouse Management

製品とサービスの管理

購入請求書の管理

購入返品管理

販売提案管理

売上請求書管理

売上請求書の返品管理

アカウント管理

プロジェクト管理

POS管理

CRM管理

人事管理管理

ドキュメント内の各 API エンドポイントには、開発環境やテスト ツールでコピーして直接使用できる実用的な例が含まれています。応答例には、成功した操作と一般的なエラー シナリオの両方が示されており、アプリケーションに適切なエラー処理を実装するのに役立ちます。

モジュールに関する賢明な API リスト:

これは役に立ちましたか?
← すべてのドキュメントチームに質問してください無料で試してみる→