Zum Inhalt
Startseite » Ihr Leitfaden zum Erstellen von REST-APIs

Ihr Leitfaden zum Erstellen von REST-APIs

API steht für Application Programming Interface. Jede Software mit einer bestimmten Funktion wird im Zusammenhang mit APIs als Anwendung bezeichnet. Sie können die API-Schnittstelle mit einer Servicevereinbarung zwischen zwei Programmen vergleichen, die Anforderungen und Antworten festlegen. Wenn Sie neu bei APIs sind, empfehlen wir Ihnen, sich unsere anzuschauen Leitfaden für Anfänger zu APIs und Überblick über REST-APIs Blog, bevor Sie diesen lesen.

REST-APIs ermöglichen Ihnen den Zugriff auf CRM-Daten über das HTTP/HTTPS-Protokoll. Sie können Aktionen wie das Erstellen, Aktualisieren, Abrufen oder Löschen von Vorgängen für alle CRM-Datensatzinformationen ausführen. Außerdem können Sie nebenstellenspezifische und benutzerspezifische Konfigurationsdaten speichern oder mithilfe der gespeicherten nebenstellenspezifischen Daten eine Verbindung zu externen Anwendungen herstellen. Auf alle diese Daten kann mit einer Basisberechtigung zugegriffen werden, dh mit dem Benutzernamen und dem Zugangsschlüssel.

Erstellen einer REST-API

Im Folgenden sind die fünf allgemeinen Schritte aufgeführt, mit denen Sie jede API erstellen können:

  1. Planen Sie die API: Die Richtlinien für das Entwerfen Ihrer API werden von API-Spezifikationen wie OpenAPI bereitgestellt. Es ist vorzuziehen, verschiedene Anwendungsfälle im Voraus zu berücksichtigen und sicherzustellen, dass die API den aktuellen API-Entwicklungsstandards entspricht.
  2. Erstellen Sie die API: API-Designer erstellen Prototypen neuer APIs mit geringfügigen Änderungen an den bestehenden APIs. Entwickler können den Prototypen nach dem Testen an interne Anforderungen anpassen.
  3. Testen Sie die API: Ähnlich wie bei Softwaretests ist API-Testen notwendig, um sich vor Fehlern und Schwachstellen zu schützen. Testen Sie die API auf Stärke gegen Online-Angriffe mit Tools für API-Tests.
  4. Dokumentieren Sie die API: Obwohl APIs selbsterklärend sind, kann die Dokumentation Benutzern leichter helfen. In einer serviceorientierten Architektur kommen häufiger gut dokumentierte APIs mit unterschiedlichen Funktionen und Anwendungsfällen zum Einsatz. Schreiben Sie ein Hilfedokument, um Anweisungen zu geben und anderen beim Erstellen ihrer APIs zu helfen.
  5. Vermarkten Sie die API: Es gibt Online-Marktplätze, auf denen Entwickler APIs kaufen und an andere verkaufen können, genau wie für Einzelhandelswaren bei eBay, Amazon und Flipkart. Sie können mit Ihrer API Geld verdienen, indem Sie sie auflisten.

In diesem Blog erfahren Sie, wie Sie mit dem API Designer von Vtiger einen benutzerdefinierten REST-API-Befehl erstellen. Also lasst uns anfangen.

Was ist ein API-Designer?

Der API Designer ist ein Tool oder Anwendungsentwickler, mit dem benutzerdefinierte Webdienst-APIs erstellt werden können. Sie können Ihre benutzerdefinierten Dienstendpunkte und Abfrageparameter definieren. Diese APIs können verwendet werden, um mit CRM-Daten zu interagieren, in externe Apps zu integrieren und diese Daten auch VTAP-JavaScript-APIs zur Verwendung auf benutzerdefinierten Seiten oder Widgets in der Vtiger-Benutzeroberfläche bereitzustellen.

Sie können APIs mit der Vtiger Application Design Language erstellen (VADL), die lose auf der XML-Syntax basiert. Die VADL ermöglicht es Administratoren oder Entwicklern ohne Programmierkenntnisse auf hohem Niveau, APIs einfach zu definieren, aber mit einem grundlegenden Verständnis der Programmierung können Sie schnell effektive APIs erstellen.

REST-APIs folgen dem standardmäßigen REST-API-Protokoll, und Sie können ihre Endpunkte wie folgt definieren:

https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH

Für die REST-API werden die folgenden HTTP-Anforderungsmethoden unterstützt:

  • BESTELLE
  • jetzt lesen
  • SETZEN
  • LÖSCHEN

Lassen Sie uns sehen, wie Sie VTAP verwenden können, um Ihre benutzerdefinierte REST-API zu erstellen.

Vtiger CRM-Benutzer können REST-APIs erstellen, die das CRM mit anderen Anwendungen von Drittanbietern verbinden, oder neue erstellen, die die Funktionalität des CRM erweitern. Hier ist ein Beispiel:

Lassen Sie uns eine REST-API erstellen, die das kann Zugriffsdaten von eine spezifische Modulen mit dem VTAP.

Nachfolgend finden Sie ein Beispiel für die API, die Daten abruft aus dem aufgerufenen CRM-Modul Organisationen um die fünf führenden Organisationen mit dem höchsten Jahresumsatz mit einem API-Namen als anzuzeigen top_organisationen. Sie können einen anderen Namen verwenden, um ihn eindeutig zu halten.

Bevor wir beginnen, lassen Sie uns die XML- und VDAL-Komponenten verstehen, die verwendet werden, um die Aktionen des obigen API-Beispiels zu definieren.

Die folgende Tabelle beschreibt die XML- und VDAL-Komponenten, die verwendet werden, um die benutzerdefinierte REST-API für den Zugriff auf und die Anzeige von CRM-Daten zu definieren:

XML- und VDAL-Komponente Action
API-Methode = "get" HTTP-Request-Methode definieren
select module="Konten" Definieren Sie das Modul, aus dem Daten abgerufen werden sollen wählen
Rekord
Feldname=”Kontoname”>
Definieren Sie die Felder im Datensatz, aus denen Daten abgerufen werden sollen Rekord
sortieren
Feldname = „Jahresumsatz“ Auftrag = „absteigend“ /Feld
/Sortieren
Definieren Sie die Bedingungen für das Tabellenergebnis mit sortieren
limit max=“5″ page=“@page“ /limit Definieren Sie mit die Anzahl der anzuzeigenden Datensatzdetails begrenzen
/wählen
/API
Beenden Sie mit dem Schließen aller offenen Tags

Note dass alle XML- und VDAL-Komponenten in der obigen Tabelle in Tags (<>) einzuschließen sind.

Befolgen Sie diese Schritte, um die oben beschriebene REST-API zu erstellen:

  1. Melden Sie sich bei Ihrem Vtiger CRM-Konto an.
  2. Klicken Sie auf die Inhalte.
  3. Klicken Sie auf Plattform.
  4. Select API-Designer.
  5. Klicken Sie auf +API hinzufügen.
  6. image1

  7. Klicken Sie auf Erstellen neben REST-API. Das Fenster REST-API hinzufügen wird geöffnet.
  8. image4

  9. REST-API hinzufügen: Informationen für Folgendes eingeben oder auswählen:
    1. Modul: Wählen Sie das CRM-Modul aus, aus dem auf Daten zugegriffen werden soll.
    2. Name und Vorname: Geben Sie einen eindeutigen Bezeichner für die API ein.
    3. Status: Klicken Sie auf das Kontrollkästchen, um die API zu aktivieren.
  10. Klicken Sie auf Speichern.
  11. image2

  12. Nachdem Sie die API hinzugefügt haben, sehen Sie eine integrierte IDE, in der Sie VADL verwenden, um APIs und XML-Knoten zum Abrufen von CRM-Daten zu definieren. Informationen zu den XML- und VADL-Komponenten finden Sie in der obigen Tabelle.
  13. image3

  14. Klicken Sie auf Speichern und veröffentlichen um die erstellte API zu veröffentlichen.

Sie können auf die obige REST-API von jeder externen Anwendung aus zugreifen und sie testen, indem Sie die folgende URL verwenden.

https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations

Note dass die obige URL ein Beispiel ist und Sie den Endpunkt gemäß Ihrer CRM-Instanz definieren müssen.

Wussten Sie schon?
Die oben genannten Daten können verwendet werden, um sie als Liste auf einer benutzerdefinierten Seite anzuzeigen oder für ein Balkendiagramm und andere dynamische Ergebnisse unter Verwendung von Javascript-Komponenten zum Definieren Ihrer APIs verwendet werden. Auf alle benutzerdefinierten REST-APIs, die in API Designer erstellt wurden, kann auch mit zugegriffen werden VTAP-JavaScript-APIs.

Weitere Informationen zum Erstellen benutzerdefinierter APIs und VTAP finden Sie unter VTAP-Dokumentation.