Rest API バナーの作成 (1)

REST API 構築ガイド


APIはアプリケーションプログラミングインターフェースの略です。 API について説明する場合、特定の機能を持つソフトウェアはアプリケーションと呼ばれます。 API インターフェイスを、要求と応答を指定する XNUMX つのプログラム間のサービス契約と比較できます。 API を初めて使用する場合は、こちらをご覧になることをお勧めします API の初心者向けガイド および REST API の概要 このブログを読む前に。

REST API HTTP/HTTPS プロトコルを介して CRM データにアクセスできます。 任意の CRM レコード情報に対して、作成、更新、取得、または削除操作などのアクションを実行できます。 また、拡張機能固有およびユーザー固有の構成データを保存したり、保存された拡張機能固有のデータを使用して外部アプリケーションに接続したりすることもできます。 このすべてのデータには、ユーザー名とアクセス キーによる基本認証を使用してアクセスできます。

REST API の作成

以下は、任意の API を構築するために使用できる XNUMX つの一般的な手順です。
  1. API を計画する: API を設計するためのガイドラインは、OpenAPI などの API 仕様によって提供されます。 事前にさまざまなユースケースを検討し、API が現在の API 開発標準に準拠していることを確認することが望ましいです。
  2. API を構築する: API 設計者は、既存の API をほとんど変更せずに、新しい API のプロトタイプを作成します。 開発者は、テスト後にプロトタイプを内部要件に適合させることができます。
  3. API をテストする: ソフトウェア テストと同様に、エラーや欠陥を防ぐために API テストが必要です。 API テスト用のツールを使用して、オンライン攻撃に対する API の強度をテストします。
  4. API を文書化する: API は一目瞭然ですが、ドキュメントはユーザーにとってより簡単に役立ちます。 サービス指向アーキテクチャでは、さまざまな機能とユースケースを備えた十分に文書化された API がより頻繁に使用されます。 方向性を示し、他のユーザーが API を構築するのを支援するヘルプ ドキュメントを作成します。
  5. API のマーケティング: eBay、Amazon、Flipkart の小売商品と同様に、開発者が API を売買できるオンライン マーケットプレイスがあります。 API をリストすることで、API から収益を得ることができます。
このブログでは、Vtiger の API Designer を使用してカスタム REST API コマンドを作成する方法を説明します。 それでは始めましょう。

API デザイナーとは何ですか?

API Designer は、カスタム Web サービス API を構築するために開発者が使用できるツールまたはアプリケーションです。 カスタム サービス エンドポイントとクエリ パラメータを定義できます。 これらの API を使用して、CRM データとやり取りしたり、外部アプリと統合したり、これらのデータを VTAP Javascript API に公開して、Vtiger UI のカスタム ページまたはウィジェット内で使用したりできます。

Vtiger Application Design Language (VADL)、これは大まかに XML 構文に基づいています。 VADL を使用すると、高度なプログラミング スキルを持たない管理者や開発者でも API を簡単に定義できますが、プログラミングの基本的な知識があれば、効果的な API をすばやく作成できます。

REST API は標準の REST API プロトコルに従い、エンドポイントを次のように定義できます。
https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH

REST API では、次の HTTP 要求メソッドがサポートされています。
  • GET
  • POST
  • PUT
  • DELETE
VTAP を使用してカスタム REST API を構築する方法を見てみましょう。

Vtiger CRM ユーザーは、CRM を他のサードパーティ アプリケーションに接続する REST API を構築したり、CRM の機能を拡張する新しい API を構築したりできます。 次に例を示します。

ことができるREST APIを作成しましょう からデータにアクセスする 特定の モジュール VTAP を使用します。

以下は、 データを取得する API という CRM モジュールから 企業・組織の方へ API 名が トップ組織. 一意に保つために、別の名前を使用できます。

始める前に、上記の API の例のアクションを定義するために使用される XML および VDAL コンポーネントを理解しましょう。

次の表では、CRM データにアクセスして表示するカスタム REST API を定義するために使用される XML および VDAL コンポーネントについて説明します。
XML および VDAL コンポーネント アクション
APIメソッド=”get” HTTP リクエスト メソッドの定義
select module="アカウント" を使用してデータを取得するモジュールを定義します select
レコード フィールド名="アカウント名"> を使用してデータを取得するレコードのフィールドを定義します。 記録
並べ替え フィールド名=”年収” 順序=”降順” /フィールド /並べ替え を使用して表の結果の条件を定義します。 sort
limit max=”5″ page=”@page” /limit を使用して表示するレコード詳細の数を定義します 制限
/選択 /api 開いているタグをすべて閉じて終了
注意 上記の表のすべての XML および VDAL コンポーネントをタグ (<>) で囲む必要があります。

上記の REST API を構築するには、次の手順に従います。
  1. Vtiger CRM アカウントにログインします。
  2. ストリーミングを停止する場合は上部の メインメニュー.
  3. 【送信】ボタンをクリックします。販売者は原則としてXNUMX日以内に回答を返信します。XNUMX日を過ぎても回答がない場合は、Artisanaryまでお問い合わせください。 プラットフォーム.
  4. 次の項目を選択します。: APIデザイナー.
  5. 【送信】ボタンをクリックします。販売者は原則としてXNUMX日以内に回答を返信します。XNUMX日を過ぎても回答がない場合は、Artisanaryまでお問い合わせください。 +APIを追加.

  6. image1
  7. 【送信】ボタンをクリックします。販売者は原則としてXNUMX日以内に回答を返信します。XNUMX日を過ぎても回答がない場合は、Artisanaryまでお問い合わせください。 データドリブン REST API の横にあります。 REST API の追加ウィンドウが開きます。

  8. image4
  9. REST API を追加: 次の情報を入力または選択します。
    1. モジュール: データにアクセスする CRM モジュールを選択します。
    2. お名前: API の一意の識別子を入力します。
    3. 状態: チェックボックスをクリックして API を有効にします。
  10. 【送信】ボタンをクリックします。販売者は原則としてXNUMX日以内に回答を返信します。XNUMX日を過ぎても回答がない場合は、Artisanaryまでお問い合わせください。 セールで節約.

  11. image2
  12. API を追加すると、VADL を使用して API と XML ノードを定義し、CRM データを取得する組み込みの IDE が表示されます。 XML および VADL コンポーネントを理解するには、上の表を参照してください。

  13. image3
  14. 【送信】ボタンをクリックします。販売者は原則としてXNUMX日以内に回答を返信します。XNUMX日を過ぎても回答がない場合は、Artisanaryまでお問い合わせください。 保存して公開 ビルドした API を公開します。
次の URL を使用して、任意の外部アプリケーションから上記の REST API にアクセスしてテストできます。
https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations

注意 上記の URL は一例であり、CRM インスタンスごとにエンドポイントを定義する必要があります。

ご存知でしたか? 上記のデータは、カスタム ページにリストとして表示するために使用したり、API を定義する JavaScript コンポーネントを使用して棒グラフやその他の動的な結果に使用したりできます。 API Designer に組み込まれているすべてのカスタム REST API には、次を使用してアクセスすることもできます VTAP Javascript API.

カスタム API と VTAP の構築について詳しくは、こちらをご覧ください。 VTAP ドキュメント.