コンテンツにスキップ
ホーム » VTAP API Designer入門–パート2

VTAP API Designer入門–パート2

以前、Vtiger Application Platform (VTAP) ブログシリーズで、特定のビジネスニーズに応えるために Vtiger インターフェイスをカスタマイズし、カスタムボタンとウィジェットを導入する方法について説明しました。 これは、プラットフォームが提供する機能の XNUMX つにすぎません。

VTAP は、以下に役立つ多くの機能を提供します。

  • カスタムRESTAPIを作成する
  • RESTAPIを利用できる他のアプリケーションに接続します
  • OAuth対応アプリケーションに接続する

このブログでは、カスタム REST API を作成する方法について説明します。
まず、Vtiger REST API について少し話させてください。 CRM インスタンスに固有の以下のエンドポイントでアクセスできます。

例えば、https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default

あなたがVtigerを知っているなら 残りのAPI、その後、以下のセクションをスキップできます。 アクセス可能なモジュールについて知るには、 リストタイプ APIです。

これは、郵便配達員クライアントを使用して API にアクセスする方法のスクリーンショットです。

リストタイプ API

VtigerはすでにAPIの標準セットを提供していますが、新しいAPI Designerツールを使用すると、独自のカスタムRESTAPIを作成できるようになりました。

APIデザイナー

API Designerは、開発者がVTAP JavascriptAPIまたは外部アプリケーションに公開して簡単に統合できるHTTPベースのAPIを開発するためのワークベンチを提供します。 APIは、を使用して定義できます ヴァドル 仕様。
API アクセスにはユーザーの承認が必要で、CRM 内で作成された標準のレコード アクセス設定に従います。
API デザイナーは、カスタム API を作成するための IDE を提供します。 特定のモジュールのカスタム REST API を作成する場合は、API に名前を付けてモジュールを選択する必要があります。

サブイメージ-2

Vtiger Application Definition Language(VADL)を定義しました。これは、XML構文に基づいており、初心者の管理者や開発者がプロ​​グラミングの専門知識がなくてもAPIを定義できるようにします。

ヴァドル あなたがすることができます:

  • CURDを定義する
    • エンティティモジュールのAPI(作成、更新、取得、削除)
    • (GET / POST / PUT / DELETE)メソッドを介してHTTPベースの(REST / SOAP)エンドポイントを呼び出す
      • 認証あり(基本/ベアラートークンベース)
    • リクエストパラメータを受け入れ、API入力としてバインドします

メールドメインに一致する連絡先を検索するカスタムRESTAPIを作成する例を見てみましょう。 'fetch_email_contact'という名前の新しいAPIを追加し、Contactsモジュールを選択します

コードサブイメージ-1

すべての定義は内部に配置されます API 標準のHTTPタイプ(get、post、put、およびdelete)のノード。 CRMからデータを取得しているので、 ノードを選択 モジュール名を渡します。 内部にフェッチする必要のあるフィールドがあります レコードノード および内部のフィルター条件 コラボレー ノード。 さまざまなタイプをサポートします 条件 等しい、等しくない、のように、より大きい、より小さいなど。

上記は簡単な例であり、既存のものを使用して実現することもできます クエリー REST API:複数のAPIをXNUMXつに組み合わせると、真の力が明らかになります。

この例を考えてみましょう。 レコードが存在する場合は更新し、存在しない場合は作成します。 既存のAPIを使用する場合、これらの操作を実行するには複数の呼び出しが必要になります。 ただし、API Designerを使用すると、これらの操作をXNUMXつのAPI呼び出しに組み合わせることができます。

コードサブイメージ-2

上記の例では、定義を内部に配置しています アップサート ノード。 これは、 update および 作ります ノード。レコードが存在する場合はそれを更新し、存在しない場合はレコードを作成します。 更新する必要があるレコードを特定するには、フィルタリングする場所を使用して、関連するエントリを検索します。 定義の最後に、リターン ノードは定義されたフィールドをクライアントに送り返します。
これらの API を保存および公開して、外部アプリケーションおよび内部 VTAP Javascript で使用できるようにすることができます。

APIデザイナを通じて公開されたカスタムAPIへのアクセス

  • API Designerを介して公開されたカスタムAPIにアクセスするには、以下のエンドポイントを使用する必要があります。
  • https://your_instance.odx.vtiger.com/restapi/vtap/api/API_NAME?パラメーター
  • API_NAMEは、APIに付けられた名前に置き換える必要があります。 また、適切なHTTPタイプを使用していることを確認してください。 資格情報(ユーザー名とアクセスキー)にアクセスします。

最近作成されたものへのアクセス fetch_email_contact postmanを使用したAPI

  • 最近作成されたものにアクセスするには fetch_email_contact postmanを使用するAPI、以下を使用する必要があります。
  • https://your_instance.odx.vtiger.com/restapi/vtap/api/fetch_email_contact?domain=%vtiger.com%

Note :https://your_instance.odx.vtiger.com/restapi/v1/ApiDesigner/api/fetch_email_contact?domain =%vtiger.com%は非推奨です。

サブイメージ-3(1)

これらのAPIは、VTAP JavascriptAPIを使用してModuleDesignerの内部でアクセスできます。 VTAP.CustomApi.Get Vtigerユーザーインターフェイスのウィジェットまたはカスタムページ内に表示します。

コードサブイメージ-3


結論として、API デザイナー ツールを使用してカスタム REST API を作成し、それを内部および他のアプリケーションで使用して、CRM データをシームレスに利用できる方法を確認しました。
その他の質問については、にメールを送ってください [メール保護]。 開発者版にサインアップする (茶事の話はこちらをチェック).