PestScan REST-API - Technische Informationen

Überblick

Unsere REST-API ermöglicht die Verbindung zwischen der PestScan-Software und Drittanbietersoftware.

Beispiele für Drittanbietersoftware sind:

- Buchhaltungssoftware

- CRM/ERP-Software

- Planungssoftware

- Eine Website, die es externen Nutzern erlaubt, Aufträge oder Besuche zu erstellen

Dieses Dokument informiert Sie über die folgenden Punkte:

- Allgemeine Informationen

- Voraussetzungen für eine Verbindung

- Finanzielle Informationen

- Technische Informationen

- Anwendungsbeispiele

Allgemeine Informationen

Die Rest API kann genutzt werden, um eine Verbindung zwischen der PestScan-Software und Drittanbietersoftware herzustellen. Im untenstehenden Bild sehen Sie eine schematische Darstellung der Situation. Der Anschluss eines Drittanbieters sendet Daten an PestScan und kann Daten von PestScan abrufen. Beispiele für Anwendungsfälle finden Sie am Ende dieses Dokuments.

Voraussetzungen für eine Verbindung

Die REST-API von PestScan ist bereits im Einsatz. Die API der Drittanbietersoftware muss so entwickelt werden, dass sie mit der REST-API von PestScan verbunden werden kann.
Hinweis: Dies wird nicht von PestScan übernommen!

In manchen Fällen stellt der Drittanbieter einen Entwickler, der die API erstellt. In den meisten Fällen benötigen Sie jedoch einen Vermittler, der die erforderliche API entwickelt.

Finanzielle Informationen

Für die Nutzung der REST-API erhebt PestScan eine monatliche Gebühr.
Bitte wenden Sie sich für weitere Informationen an unseren Vertrieb: sales@pestscan.eu

Technische Informationen

In der nachfolgenden Tabelle finden Sie eine Übersicht der verfügbaren Endpunkte. Um die technische Dokumentation (Swagger-Dokumentation) zu erhalten, kontaktieren Sie bitte unseren Support: support@pestscan.freshdesk.com.

Optimale Vorgehensweisen

Nur geänderte oder neue Daten senden: Wenn z.B. eine Adresse eines Kunden in Ihrer Drittanbietersoftware geändert wird, senden Sie nur den geänderten Datensatz und nicht die gesamte Kundenliste erneut. Unsere Software erkennt, wenn Sie komplette Datensätze wiederholt senden, und wird Sie auffordern, Ihren Code zu ändern.

Vermeiden Sie zu häufiges Abfragen: Bestimmte Daten, wie z.B. abgeschlossene Besuche, können von PestScan abgerufen werden. Verwenden Sie ein sinnvolles Abfrageintervall, z.B. alle 15 bis 60 Minuten.

Änderungen sofort senden: Senden Sie jede Änderung unmittelbar, damit PestScan-Nutzer die Änderungen so schnell wie möglich sehen können.

Alle Fehler protokollieren: Dokumentieren Sie alle Fehler, die während der API-Nutzung auftreten. Jede API-Anfrage gibt eine Liste von Fehlern zurück, die entweder gefüllt oder leer sein kann.

Kleine Datensätze senden: Senden Sie geänderte Datensätze in kleinen Schritten. Wenn z.B. 100 Kunden geändert wurden, senden Sie sie in 4 Schritten à 25 Datensätze.

Zeitüberschreitungen vermeiden: Achten Sie darauf, dass keine Zeitüberschreitungen auftreten. Wenn doch, kontaktieren Sie bitte PestScan.

Anwendungsbeispiele

Beispiel 1: Kunden

In diesem Fall erstellen Sie Ihre Kunden in Ihrer Drittanbietersoftware, einschließlich aller Informationen wie Name, Adresse und Kontaktdaten. Sie können Standorte für Ihre Kunden anlegen, die mit PestScan synchronisiert werden können. Neue Kunden und Standorte müssen zunächst gesendet werden. Änderungen können jederzeit an PestScan übermittelt werden.

Bespiel 2: Mitarbeiter

Mitarbeiter können in Ihrer Drittanbietersoftware eingepflegt und an PestScan übermittelt werden. In PestScan können dann weitere Informationen, wie Benutzername oder Passwort, festgelegt werden.

Beispiel 3: Artikel

Sie können Ihre Artikelliste in Ihrer Drittanbietersoftware erstellen und an PestScan senden. In PestScan können Sie zusätzliche Informationen zu den Artikeln hinzufügen.

Beispiel 4: Besuche

Besuche können in Ihrer Drittanbietersoftware erstellt und an PestScan übermittelt werden. Diese Besuche werden einem Mitarbeiter und einem Kundenstandort zugewiesen. Wichtig ist, dass Mitarbeiter und Standorte bereits in PestScan existieren, bevor ein Besuch gesendet wird. Abgeschlossene Besuche können nachträglich aus PestScan abgerufen werden und enthalten wichtige Informationen wie Arbeitszeit, Kommentare und verwendete Artikel.

Hinweis: Alle oben genannten Szenarien können miteinander kombiniert werden. Beispielsweise setzt Szenario 4 die Umsetzung von Szenario 1, 2 und 3 voraus.