Menu

REST-API verwenden

1CRM verfügt über einen REST-API, über die Daten aus allen Modulen (bis auf wenige Ausnahmen wie beispielsweise Benutzer und Berechtigungen) ausgelesen sowie erstellt, aktualisiert und gelöscht werden können.

In dieser Anleitung erfahren Sie, was Sie mit der REST-API von 1CRM machen können.

Aufruf API-Doks über ihre-crm-url/api.php, z. b.: https://demo.1crm.de/api.php

 

Voraussetzungen

Zielgruppen: Admin
Produkte: Professional Edition , Enterprise Edition
Hinweis:

Die API lässt sich nur bei einer Professional oder Enterprise Edition von 1CRM nutzen. Bei den Editionen Startup und Startup+ ist die API nicht aktiviert.

Was ist eine REST-API?

Ü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.

Was können Sie mit der REST-API machen?

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.

Aufruf der REST-API

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:

Funktionsweise der REST-API

 

 

Zugriff auf die Module

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!

Tipp für On-Premises-Kunden:

Wenn Sie die Namen der Module herausfinden möchten, können Sie auch in die Datenbank schauen, sofern Sie Zugriff auf die Datenbank haben.

Felder und Filter

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.

Anwendungsfälle mit der REST-API

Anbindung an Power-BI

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

Weitere Anwendungsfälle

AnwendungsfallErläuterung
CRM-Kontakte einlesen, ändern und erstellen,Eine ausführliche Erklärung finden Sie in: Praxis-Beispiel REST: CRM-Kontakte einlesen, ändern und erstellen
CRM-Daten in Excel einlesenEine ausführliche Erklärung finden Sie in: CRM-Daten in Excel einlesen
1CRM über das Tool Integromat mit weiteren Tools wie Jira, Mautic oder Microsoft 365 verbindenEine ausführliche Erklärung finden Sie in: Workflow-Automatisierung mit 1CRM und Integromat
1CRM System hat 4,72 von 5 Sternen 23 Bewertungen auf ProvenExpert.com