. .

REST API ENTWICKLER-
HANDBUCH

Hier gelangen Sie zum
REST API Entwicklerhandbuch

PROFFIX REST API Template für die verwaltete Erweiterung: zum Template

PROFFIX REST API


1. PROFFIX REST API

Die PROFFIX REST API ist ein HTTP-basierter REST-Webservice. Er bietet einfachen Zugriff auf ausgewählte Entitäten aus PROFFIX.

1.1 API Aufruf und Antwort
Daten werden per HTTP über eine URL abgerufen. Jede URL beschreibt einen eindeutigen Datensatz, bzw. eine Liste aus mehreren Datensätzen. Diese Datensätze oder Listen werden Ressourcen genannt.

Das URL-Schema sieht wie folgt aus:
Alle Werte in geschweiften Klammern sind Platzhalter. Platzhalter mit Fragezeichen sind optional.

https://{Hostname}/pxapi/{API-Version}/{Modul}/{Controller}?{?QueryParameter}
Die PROFFIX REST API unterstützt nur Antworten als JSON.

1.2 Installation und Lizenzierung
Die PROFFIX REST API kann mit der PROFFIX REST API Konfiguration installiert und verwaltet werden.

Die Lizenzierung der PROFFIX REST API unterscheidet sich von der Lizenzierung von PROFFIX:
In der PROFFIX REST API wird in der Konfiguration die benötigte Anzahl Lizenzen definiert und die Verrechnung geschieht automatisch. Es müssen für die PROFFIX REST API keine Lizenzen bei PROFFIX verlangt werden.

Die Lizenzierung der PROFFIX REST API ist grundsätzlich immer zusätzlich zum jeweiligen PROFFIX Modul. Beispielsweise möchten Sie in unserer App «PROFFIX Leistungserfassung mobile» Rapporte von unterwegs erfassen, so benötigt diese App die PROFFIX REST API. Die PROFFIX REST API wiederum benötigt eine «normal» lizenzierte PROFFIX Leistungsverwaltung und diese wiederum die PROFFIX Adressverwaltung.

1.3 Beispiel
Ein Zugriff auf die Entität «Rapport» mit der ID 5 würde folgendermassen aussehen:
GET /pxapi/v2/STU/Rapport/5 HTTP/1.1
1.4 Dokumentation
Zum offiziellen Entwicklerhandbuch zur PX REST API gelangen Sie unter folgendem Link:
REST API Entwicklerhandbuch

1.5 PROFFIX REST API Erweiterungen
Die PROFFIX REST API bietet eine Vielzahl von Funktionen an. Durch die PROFFIX REST API Erweiterungen können eigene Funktionalitäten hinzugefügt werden, wodurch die Flexibilität in Kundenprojekten erhöht wird.

Eine Erweiterung ist ein Webservice, also ein eigenständiger Prozess, mit dem via HTTP/HTTPS kommuniziert wird. Die PROFFIX REST API Konfiguration kennt zwei Erweiterungstypen.
Erweiterungen können als «verwaltete Erweiterung» oder als «nicht verwaltete Erweiterung» konzipiert werden. Bei verwalteten Erweiterungen übernimmt die PROFFIX REST API Konfiguration die komplette Inbetriebnahme der Erweiterung. Bei nicht verwalteten Erweiterungen übernimmt dies der Systemadministrator, dafür sind diese Erweiterungen unabhängiger.

Weitere Informationen zu den PROFFIX REST API Erweiterungen finden Sie im Entwicklerhandbuch unter Allgemein > Erweiterungen.


FRAGEN?

Dann zögern Sie nicht, mit uns in Kontakt zu treten.

 
  • Proffix bei Facebook
  • Proffix bei Twitter
  • Proffix Suche
  • Proffix Quicklinks

Bitte geben Sie oben Ihren Suchbegriff ein.