REST-API verwenden

Über eine REST-API (Representational State Transfer-API) lassen sich webbasierte Apps miteinander verbinden, sodass die Apps miteinander kommunizieren können. Theoretisch ist die API mit jedem Protokoll oder Datenformat kompatibel, verwendet aber meistens das HTTP-Protokoll und überträgt die Daten mithilfe von JSON. Mit einer REST-API lässt sich somit eine Schnittstelle zwischen Systemen herstellen.

Grundlegende Informationen zu Schnittstellen erhalten Sie in unserem Beitrag Was ist eine Schnittstelle?.

Genauere Erläuterungen zur REST-API inkl. einer Anleitung, wie Sie CRM-Kontakte einlesen, ändern und erstellen, erhalten Sie in unserem Beitrag Was ist eine REST-API? Eine praktische Erklärung.

Mit der 1CRM-REST-API lassen sich Daten aus allen 1CRM-Modulen (bis auf wenige Ausnahmen wie beispielsweise Benutzer und Berechtigungen) auslesen sowie erstellen, aktualisieren und löschen. Sie können darüber sowohl alle Standard-Felder als auch Custom-Fields bearbeiten. Als Filterfelder stehen im Standard nur die Felder zur Verfügung, die auch in den Listenansichten in 1CRM verfügbar sind (das ist aus den Meta-Informationen der Schnittstelle ersichtlich).

Die Beschreibung der 1CRM-API finden Sie z. B. unter  https://demo.1crmcloud.com/api.php  oder in https://1crm.com/docs/1CRM_8.6_Developer_Guide.pdf.

OpenAPI-Dokumentationen für einige Module haben wir aktuell unter https://github.com/visual4/1crmOpenApi veröffentlicht.

Die API lässt sich über folgende URL aufrufen: https://[CRMURL]/api.php, wobei [CRMURL] die URL zu Ihrem 1CRM-System entspricht.

Beispiel:

https://demo.1crm.de/api.php

Um die API aufzurufen, brauchen Sie:

• einen API Client (z. B. von 1CRM selbst: https://github.com/1CRM/1crm-api-client-php)
• einen authentifizierter Benutzer (bei unserem Demosystem ist das z. B. der Benutzer+Passwort: maier/maier)

Sie verwenden in der API immer den Model-Namen, der in der Regel der englischen Modulbezeichnung in Einzahl entspricht, also z. B. Account, Contact, Lead, Opportunities etc.

Eine Liste der Module und den zugehörigen Models lässt sich über die API abrufen. Die URL dazu lautet:

[CRMURL]/api.php/meta/modules

Eine Auflistung aller Module und deren Bezeichnungen über die API finden Sie auch in diesem Download: REST-API 1CRM-Module

Um z. B. auf die Interessenten unseres Demosystems zuzugreifen, lautet die URL:

https://demo.1crm.de/api.php/data/Lead

Natürlich bestätigen ein paar Ausnahmen diese Regel, falls der Zugriff auf bestimmte Daten nicht klappt, helfen wir gerne weiter!

Es ist möglich, über die API die Liste der Felder zu einem Modul abzufragen oder ein Feld (z. B. den Namen der Firma) anzusprechen und seinen Wert zu ändern. Des Weiteren lassen sich Filter verwenden.

Mehr zu Feldern und Filtern erfahren Sie in unserem Beitrag Was ist eine REST-API? Eine praktische Erklärung.

Um beispielsweise ein externes Reporting Tool wie Power-BI einzubinden, sind folgende Schritte erforderlich:

• Daten abrufen ( Datenquelle) > Web ( zum Beispiel / Ihre URL /api.php/data/Account)
• Zugriff auf Webinhalte über Standard wählen und authentifizieren
• In Powerquery Liste auswählen und in Tabelle konvertieren
• Werte in Spalten umwandeln > Spalte Column1 erweitern