Zuvor haben wir in unserer Blogreihe zur Vtiger Application Platform (VTAP) darüber gesprochen, wie man die Vtiger-Schnittstelle anpassen und benutzerdefinierte Schaltflächen und Widgets einbinden kann, um spezifischen Geschäftsanforderungen gerecht zu werden. Dies ist nur eine der Funktionen, die die Plattform bietet.
VTAP bietet Ihnen viele solcher Funktionen, die Ihnen dabei helfen:
- Erstellen Sie eine benutzerdefinierte REST-API
- Stellen Sie eine Verbindung zu anderen Anwendungen her, für die die REST-API verfügbar ist
- Verbindung zu OAuth-fähigen Anwendungen herstellen
In diesem Blog werde ich diskutieren, wie wir eine benutzerdefinierte REST-API erstellen können.
Lassen Sie mich zunächst ein wenig über Vtiger-REST-APIs sprechen. Der Zugriff erfolgt über den unten stehenden Endpunkt, der für Ihre CRM-Instanz spezifisch ist.
Beispielsweise,https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default
Wenn Sie den Vtiger kennen Rest API, dann können Sie den Abschnitt unten überspringen. Um mehr über barrierefreie Module zu erfahren, können Sie die Listentypen API.
Hier ist ein Screenshot, wie Sie mit dem Postman-Client auf die API zugreifen können.
Vtiger bietet bereits einen Standardsatz von APIs, aber mit dem neuen API Designer-Tool können Sie jetzt Ihre eigenen benutzerdefinierten REST-APIs schreiben.
API-Designer
Der API Designer bietet Entwicklern eine Workbench zum Entwickeln von HTTP-basierten APIs, die den VTAP-JavaScript-APIs oder der externen Anwendung zur einfachen Integration zugänglich gemacht werden können. APIs können definiert werden mit VADL Spezifikationen.
Der API-Zugriff erfordert eine Benutzerautorisierung und folgt der im CRM vorgenommenen Standardkonfiguration für den Datensatzzugriff.
Der API Designer bietet eine IDE zum Schreiben benutzerdefinierter APIs. Wenn Sie eine benutzerdefinierte REST-API für ein bestimmtes Modul schreiben, müssen Sie der API einen Namen geben und das Modul auswählen.
Wir haben die Vtiger Application Definition Language (VADL) definiert, die auf XML-Syntax basiert, damit unerfahrene Administratoren oder Entwickler APIs ohne Programmierkenntnisse definieren können.
VADL erlaubt dir zu:
- CURD definieren
- APIs (Create, Update, Retrieve, Delete) auf Entitätsmodulen
- HTTP-basierten (REST / SOAP) Endpunkt über (GET/POST/PUT/DELETE)-Methoden aufrufen
- Mit Authentifizierung (Basic / Bearer-Token-basiert)
- Anfrageparameter akzeptieren und als API-Eingaben binden
Nehmen wir ein Beispiel für die Erstellung einer benutzerdefinierten REST-API, die nach Kontakten sucht, die der E-Mail-Domäne entsprechen. Wir werden eine neue API mit dem Namen 'fetch_email_contact' hinzufügen und das Modul Kontakte auswählen
Alle Definitionen befinden sich in einem API Knoten mit Standard-HTTP-Typ (get, post, put und delete). Da wir Daten aus CRM abrufen, verwenden wir Knoten auswählen und Modulnamen übergeben. Wir werden Felder haben, die innerhalb der geholt werden müssen Datensatzknoten und alle Filterbedingungen innerhalb der woher Knoten. Wir unterstützen verschiedene Arten von Bedingungen wie gleich, nicht gleich, wie, größer als, kleiner als usw.
Oben ist ein einfaches Beispiel, das auch mit den vorhandenen query REST API.Die wahre Leistung wird deutlich, wenn Sie mehrere APIs zu einer kombinieren.
Betrachten Sie dieses Beispiel. Sie aktualisieren einen Datensatz, wenn er vorhanden ist, oder erstellen einen, wenn er nicht vorhanden ist. Wenn Sie eine vorhandene API verwenden, sind mehrere Aufrufe erforderlich, um diese Vorgänge auszuführen. Wenn Sie jedoch den API Designer verwenden, können Sie diese Vorgänge in einem einzigen API-Aufruf kombinieren.
Im obigen Beispiel platzieren wir die Definition innerhalb des Upsert Knoten. Dies umfasst die Aktualisierung und erstellen Knoten, der einen Datensatz aktualisiert, wenn er vorhanden ist, oder einen Datensatz erstellt, wenn er nicht vorhanden ist. Um den Datensatz zu identifizieren, der aktualisiert werden muss, können Sie mithilfe der Funktion „Wo“ relevante Einträge filtern und finden. Am Ende der Definition sendet der Rückgabeknoten definierte Felder an den Client zurück.
Sie können diese APIs speichern und veröffentlichen, um sie für externe Anwendungen sowie internes VTAP-JavaScript verfügbar zu machen.
Zugriff auf eine benutzerdefinierte API, die über den API-Designer veröffentlicht wurde
- Um auf eine benutzerdefinierte API zuzugreifen, die über API Designer veröffentlicht wurde, müssen Sie den folgenden Endpunkt verwenden.
- https://your_instance.odx.vtiger.com/restapi/vtap/api/API_NAME?PARAMETER
- API_NAME sollte durch den Namen ersetzt werden, der der API gegeben wurde. Stellen Sie außerdem sicher, dass Sie den richtigen HTTP-Typ verwenden und Beglaubigungsschreiben(Benutzername und Zugangsschlüssel), um darauf zuzugreifen.
Zugreifen auf ein kürzlich erstelltes fetch_email_contact API mit Postbote
- So greifen Sie auf ein kürzlich erstelltes . zu fetch_email_contact API mit Postman, sollten Sie die untenstehende verwenden.
- 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% ist veraltet.
Auf diese APIs kann intern im Modul-Designer über die VTAP-JavaScript-API zugegriffen werden VTAP.CustomApi.Get um in einem Widget oder benutzerdefinierten Seiten in der Vtiger-Benutzeroberfläche anzuzeigen.
Abschließend haben wir gesehen, wie Sie mit dem API Designer-Tool benutzerdefinierte REST-APIs schreiben und diese intern und in anderen Anwendungen verwenden können, um CRM-Daten nahtlos zu nutzen.
Bei weiteren Fragen senden Sie bitte eine E-Mail an [E-Mail geschützt] . Melden Sie sich für die Entwicklerversion an hier.
