VTAPブログの機能画像

VTAP API Designer入門–パート2

以前、Vtiger Application Platform(VTAP)ブログシリーズで、Vtigerインターフェイスをカスタマイズし、特定のビジネスニーズに対応するためにカスタムボタンとウィジェットを導入する方法について説明しました。 これは、プラットフォームが提供する機能のXNUMXつにすぎません。 VTAPは、次のような多くの機能を提供します。
  • カスタムRESTAPIを作成する
  • RESTAPIを利用できる他のアプリケーションに接続します
  • OAuth対応アプリケーションに接続する
このブログでは、カスタムRESTAPIを作成する方法について説明します。 まず、Vtiger RESTAPIについて少しお話ししましょう。 CRMインスタンスに固有の以下のエンドポイントからアクセスできます。
例えば、https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default あなたがVtigerを知っているなら 残りのAPI、その後、以下のセクションをスキップできます。 アクセス可能なモジュールについて知るには、 リストタイプ API。 これは、postmanクライアントを使用してAPIにアクセスする方法のスクリーンショットです。

リストタイプ API

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

APIデザイナー
API Designerは、開発者がVTAP JavascriptAPIまたは外部アプリケーションに公開して簡単に統合できるHTTPベースのAPIを開発するためのワークベンチを提供します。 APIは、を使用して定義できます VADL 仕様。 APIアクセスにはユーザー認証が必要であり、CRM内で作成された標準のレコードアクセス構成に従います。 API Designerは、カスタムAPIを作成するためのIDEを提供します。 特定のモジュール用にカスタムRESTAPIを作成する場合は、APIに名前を付けて、モジュールを選択する必要があります。
サブイメージ-2
Vtiger Application Definition Language(VADL)を定義しました。これは、XML構文に基づいており、初心者の管理者や開発者がプロ​​グラミングの専門知識がなくてもAPIを定義できるようにします。 VADL あなたがすることができます:
  • 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 及び 作ります ノード。レコードが存在する場合は更新し、存在しない場合はレコードを作成します。 更新が必要なレコードを特定するには、whereを使用して、関連するエントリをフィルタリングおよび検索します。 定義の最後に、リターンノードは定義されたフィールドをクライアントに送り返します。 これらのAPIを保存および公開して、外部アプリケーションおよび内部VTAPJavascriptで使用できるようにすることができます。

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%
注意 :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

結論として、APIDesignerツールを使用してカスタムRESTAPIを作成し、それらを内部および他のアプリケーションで使用して、CRMデータをシームレスに使用する方法を確認しました。 その他の質問については、にメールを送ってください [メール保護] 開発者版にサインアップする (詳細を見る)。.

タグ: , , , , , , , ,

CRM_banner 2 の AI

AI 対応の CRMS でチームの生産性を向上

顧客関係管理 (CRM) は、顧客関係を効果的に強化および管理するための最も人気のあるソフトウェアです。 このアプリケーションは堅牢で、次のような豊富な機能を備えています...
AI バナーを使用したリード管理

AIによるリード管理

評判の高い会社のセールスマネージャーであるリチャードは、彼の組織が多くのリードを生み出しているが、コンバージョン率が非常に低いことに気付きました...
Ai_powered ダッシュボード_バナー

AI を活用したダッシュボードで意思決定プロセスを強化

情報に基づいた意思決定を行うことは、ビジネスの不可欠な部分です。 重要な指標と貴重な洞察により、ビジネスの成長を確認できるのはあなただけです...
Smart Way バナーで AI 生成コンテンツを使用する方法

AI 生成コンテンツ: 長所と短所

ChatGPT の人気が高まるにつれ、AI によって生成されたコンテンツが目的に役立つかどうかについて、常に議論が行われてきました。 ChatGPTだけでなく、多くのツールが...
バナー-02

AI を活用して売上予測の精度を高める

営業は、ビジネスを前進させるために不可欠な要素です。 組織内で行う小さな一歩は、あなたが生み出す売上高に依存します...
カスタマー ケアの AI バナー

チャットボットによるカスタマー サポートの再構築

テクノロジー指向の世界では、進行中のトレンドに遅れずについていくことが不可欠です。 以前のブログで説明したように、人工的な...
Vtiger CRM-2023_Bannerへようこそ

機能豊富な Vtiger CRM で 2023 をパワーアップし、生産性を向上させましょう

こんにちは、真新しい年へようこそ! Vtiger CRMを引き続きご利用いただき、誠にありがとうございます。 私達 ...
AI 変換 CX_Banner

人工知能が顧客体験をどのように変革しているか

あなたの組織は、優れた顧客体験を提供するための専門知識を持っていますか? 待って..! カスタマーエクスペリエンスという言葉は初めてですか? もしそうなら、私たちにさせてください...
すべきこととすべきでないこと_バナー (3)

2023 年にすべきこととすべきでないこと。

元旦はもうすぐです! 多くの人にとって、2022 年は 2020 年の壊滅的な出来事と不安定な余波の後の復活の年でした...
ローディング