Skip to content

API / Integration

pfx Apps können mit anderen Apps und Proffix Zusatzentwicklungen - ganz im Sinne eines Ökosystems - plattformunabhängig verbunden werden.

pfx API

Was ist das ?

Wenn auf einem Gerät, auf welchem ein pfx App installiert ist, ein sogenannter App Link (Android) oder Universal Link (iOS) aufgerufen wird, öffnet sich das entsprechende pfx App automatisch an der entsprechenden Stelle.

Es können aber auch komplexere Parameter mitgegeben werden. Die Funktion von geteilten Filtern via DeepLink ist ein Beispiel dafür.

Wichtig: Im Unterschied zu einer Webseite oder einem Progressiven Webapp wird der Link in pfx vor dem Webbrowser geparst. Das heisst es braucht dafür prinzipiell auch keine Internetverbindung und funktioniert aus jeder installierten Anwendung auf dem Gerät (WhatsApp, SMS, Email, Dokumente, Fremdapps, etc.)

Konkrete Anwendungsbeispiele

  • Externes App für Serviceverwaltung: Anstelle alle Adressdaten, Notizen und Kontakte zu synchronisieren kann einfach ein Link (siehe unten) mitgegeben werden. Klickt der Benutzer darauf ist er direkt bei der korrekten Adresse in pfx
  • Individualentwicklung: Anstelle die Adressverwaltung noch einmal zu bauen kann einfach direkt aus dem individuellen App auf die Adresse / Kontakt in pfx verwiesen werden.
  • Auftragszuweisung: Anstelle einem Mitarbeiter im Aussendienst PDFs o.ä. zu senden, reicht es im z.B. den Link https://adresse.pfx.ch/adresse/232 oder z.B. https://leistung.pfx.ch/auftrag/TESTAUFTRAG zu senden.
  • Steuern per QR-Code: Ein DeepLink kann in einen QR-Code gepackt werden. Sobald der Benutzer den QR - Code scannt öffnet pfx automatisch das App an der entsprechenden Stelle (Bedingung: entsprechendes pfx App ist installiert)
  • Steuern per NFC (Near Field Communication): Ein DeepLink wird auf einem NFC - Tag gespeichert. Beim Lesen wird automatisch das entsprechende App auf der entsprechenden Stelle geöffnet.
  • Auftragsblätter: Anstelle Auftragsblätter / Listen auszudrucken können z.B. auf einem QR - Code ein Link auf https://liste.pfx.ch/liste/1234?AUF_Dokumente.AuftragNrPRO=2023384 mitgegeben werden. Scannt der Benutzer den QR - Code, öffnet sich das App automatisch, lädt die Selektionen und generiert (wenn Parameter run gesetzt ist) die Liste vollautomatisch

Übersicht

Folgende Links sind zurzeit verfügbar:

Adressen / Kontakte / Dokumente

Diese Links werden in pfx Adressen geöffnet

ModulLinkFunktion
Adressenhttps://adresse.pfx.ch/adressenZeigt alle Adressen an
Adressenhttps://adresse.pfx.ch/adresse/{AdressNr}Zeigt Adressdetails an
Adressenhttps://adresse.pfx.ch/kontakteZeigt alle Kontakte an
Adressenhttps://adresse.pfx.ch/kontakt/{KontaktNr}Zeigt Kontaktdetails an
Adressenhttps://adresse.pfx.ch/notizenZeigt alle Adressnotizen an
Adressenhttps://adresse.pfx.ch/notiz/{NotizNr}Zeigt Adressnotizdetail an
Adressenhttps://adresse.pfx.ch/dokumenteZeigt alle Dokumente an
Adressenhttps://adresse.pfx.ch/dokument/{DokumentNr}Zeigt Dokumentdetails an
Zeit / Stunden

Diese Links werden in pfx Zeit geöffnet

ModulLinkFunktion
Zeithttps://zeit.pfx.ch/stundenZeigt alle Stunden an
Zeithttps://zeit.pfx.ch/stunde/{StundeNr}Zeigt Stundendetail an
Zeithttps://zeit.pfx.ch/stundenferieninfoZeigt Stunden / Ferieninfo an
Zeithttps://zeit.pfx.ch/stunden-erfassenErmöglicht eine neue Stunde zu erfassen
Zeithttps://zeit.pfx.ch/autostempelnStempelt den Benutzer vollautomatisch ein oder aus
Leistungen / Aufträge / Projekte

Diese Links werden in pfx Leistung geöffnet

ModulLinkFunktion
Leistunghttps://leistung.pfx.ch/rapporteZeigt alle Rapporte an
Leistunghttps://leistung.pfx.ch/rapport-erstellenErstellt einen neuen Rapport (Siehe Parameter)
Leistunghttps://leistung.pfx.ch/rapport/{RapportNr}Zeigt Rapportdetail an
Leistunghttps://leistung.pfx.ch/auftraegeZeigt alle Aufträge an
Leistunghttps://leistung.pfx.ch/auftrag/{AuftragNr}Zeigt Auftragdetails an
Leistunghttps://leistung.pfx.ch/projekteZeigt alle Projekte an
Leistunghttps://leistung.pfx.ch/projekt/{ProjektNr}Zeigt Projektdetails an
Leistunghttps://leistung.pfx.ch/rapportdokumenteZeigt alle Rapportdokumente an
Leistunghttps://leistung.pfx.ch/rapportdokument/{RapportDokumentNr}Zeigt Rapportdokumentdetail an

Für den DeepLink rapport-erstellen sind folgende zusätzlichen Parameter möglich:

Query-ParameterNameHinweis
mitnrMitarbeiter-NrOptional; wird automatisch aus Benutzer ermittelt
stdAnzahl Stunden
auftragAuftrags-Nr
projektProjekt-Nr
teilTeilleistungs-Nr
artikelArtikel-Nr
sauftragServiceauftrags-Nr
mengeMengeNur benötigt bei Artikel
posartPositionsart
bemerkungenBemerkungen
runAutomatisches SpeichernVersucht den Rapport automatisch zu speichern
Listen / Reports

Diese Links werden in pfx Zeit geöffnet

ModulLinkFunktion
Listehttps://liste.pfx.ch/listenZeigt alle Listen an
Listehttps://liste.pfx.ch/liste/{ListeNr}Zeigt Listendetail an
  • Listen können per API automatisch generiert werden (Queryparameter run==true analog zu Rapport erstellen)
  • Selektionen der Listen können per API vorbefüllt werden. Die Parameter sind identisch mit den Proffix Parametern z.B.:
    • AUF_Dokumente.AuftragNrPRO=2023384&AUF_Dokumente.AdressNrADR=12&run=true

Automatische Auswahl des Mandanten

Aufgrund der Multimandanten - Fähigkeit von pfx können je nach Situation zusätzliche Infos in Form von Queryparameter zum gewünschten Mandanten angegeben werden.

INFO

pfx prüft nimmt automatisch den Mandanten mit den am meisten zutreffenden Kriterien.

Es liegt in der Verantwortung des Linkerstellers abzuschätzen welche Queryparameter benötigt werden. Werden keine zusätzlichen Informationen mitgegeben, wird der zuletzt in pfx verwendete Mandant verwendet.

ParameterBeispielBemerkung
pxuserGastDer Benutzername des Proffix - Benutzers
pxdatabaseDEMODBDer Datenbankname des Proffix Mandanten
pxurlremote.proffix.net:11222Die Url der Proffix Rest-API

Beispiele:

Wünsche oder Ideen ?

Die Möglichkeiten mit DeepLinks sind fast grenzenlos. Ist genau dieser DeepLink den du brauchst nicht dabei ?

Gerne erstellen wir auch sinnvolle Anpassungen für andere Entwickler oder Benutzer. Einzige Bedingung - die Anpassung wird hier für alle dokumentiert, damit auch andere davon profitieren können. Ein kurzes Mail an [email protected] genügt.