Starten Sie mit der Simple-Simon API Integration

Schützen Sie Ihre Daten und optimieren Sie Ihre Workflows mit der Simple-Simon API. Befolgen Sie diese Best Practices für eine sichere und effiziente Implementierung.

Wichtige Einschränkungen für die Nutzung der Simple-Simon API:

  • Aktive Lizenz erforderlich: Der verwendete Benutzername und das Passwort müssen mit einer aktiven Lizenz für den aktuellen Monat verknüpft sein. Dies muss kein zusätzliches Benutzerkonto sein.
  • API-Zugangsanfrage: Senden Sie eine einmalige Anfrage an den Simon Support, um den API-Zugang zu aktivieren. Sie erhalten eine E-Mail mit einer URL und vollständiger Dokumentation für jede verfügbare Methode.
  • Ihre Verantwortung: Sie sind allein verantwortlich für den Schutz Ihrer API-Zugangsdaten vor unbefugtem Zugriff und für die Aufrechterhaltung der Integrität und Qualität Ihrer Daten.
  • Kosten: Die ersten drei Monate der API-Nutzung sind kostenlos. Danach kostet der Dienst 395 € pro Jahr.

Erstellen Sie Ihre eigene Integration

Um Ihre eigene benutzerdefinierte Integration mit Simple-Simon zu erstellen, benötigen Sie Folgendes:

  1. Simon Lizenzcode: Ein 16-stelliger Simon-Lizenzschlüssel.
  2. Simon Office Benutzername: Zum Beispiel die in Ihrer Anfrage verwendete E-Mail-Adresse.
  3. Passwort: Das mit diesem Benutzerkonto verknüpfte Passwort.
  4. Einmalige Anfrage: Der API-Zugriff muss einmal angefragt werden, um die Integration zu aktivieren.

Support-Details: Der REST-Server von Simple-Simon unterstützt HTTP GET/POST-Methoden, SOAP wird nicht unterstützt. Die REST API ist nur auf Englisch verfügbar, und alle Tabellennamen sind ebenfalls auf Englisch.

Wichtige Tabellen in der Simple-Simon API

  • Customer: Repräsentiert einen Kunden. Ein Kunde kann einen oder mehrere zugehörige Arbeitsorte haben.
  • Location: Der Auftrag oder die Arbeitsadresse, die mit einem Arbeitsauftrag verknüpft ist. Ein Ort kann auch existieren, ohne mit einem Kunden verknüpft zu sein.
  • WorkOrder: Der eigentliche Arbeitsauftrag. Jeder Arbeitsauftrag ist immer mit einem Ort verknüpft.
  • ItemGroup: Eine Gruppe von Artikeln oder Materialien, die zur Organisation des Inventars verwendet wird.
  • Item: Einzelne Artikel oder Materialien innerhalb einer Artikelgruppe.
  • User: Repräsentiert sowohl Büropersonal als auch Außendienstmitarbeiter.
  • Planning: Enthält immer eine Verknüpfung zwischen einem Arbeitsauftrag und einem Benutzer (für die Planung).
  • WorkOrderSurvey: Digitale Formulare oder Checklisten, die in Simon erstellt wurden und mit einem bestimmten Arbeitsauftrag verknüpft sind.
  • UsedItem: Verwendete oder verbrauchte Materialien bei einem Arbeitsauftrag.
  • TimeSheet: Reise- und Arbeitszeiten, die mit einem Arbeitsauftrag verbunden sind.
  • Workorder/DigitalPresentation: Der digitale Arbeitsauftrag, exportiert als PDF.
  • WorkOrderSurvey/DigitalPresentation: Die ausgefüllte Umfrage oder Checkliste, exportiert als PDF.

Allgemeines

Zur Authentifizierung bei der Simple-Simon API (Restserver) müssen Sie zunächst einen Zugangstoken mit den folgenden Anmeldeinformationen abrufen:

Key: Ihr 16-stelliger Simple-Simon Lizenzcode

Pwd: Ihr Benutzerpasswort

Usr: Ihr Simon Benutzername

Nach erfolgreicher Authentifizierung erhalten Sie einen Token, der für alle nachfolgenden API-Anfragen erforderlich ist. Dieser Token hat eine Ablaufzeit. Stellen Sie sicher, dass Sie ihn regelmäßig aktualisieren, um während Ihrer Sitzung ununterbrochenen Zugang zu gewährleisten. Detaillierte Anweisungen finden Sie im HELP-Bereich am Login-Endpunkt des Simon Restservers.

 

Methodik Simons

Der Simon Restserver folgt einer konsistenten und einheitlichen Struktur über alle Tabellen hinweg. Das folgende Beispiel, das die Location-Tabelle (die einen Arbeitsplatz oder eine Arbeitsadresse repräsentiert) verwendet, gilt ähnlich für andere verfügbare Tabellen.
Sie können die folgenden Operationen an Arbeitsadressen ausführen:

location/insert

location/update

location/delete

Für Update- und Delete-Operationen müssen Sie die Simon-ID angeben. Simon verwendet immer zwei Identifikatoren: Die automatisch erstellte Simon-ID und Ihren eigenen Schlüssel/ID namens ExtKey.

ExtKey kann leer gelassen werden oder einen eindeutigen Wert haben.

Um eine Simon-ID für einen bestimmten Ort zu finden, verwenden Sie location/read. Sie können Filterparameter angeben, um die Ergebnisse einzugrenzen. Beachten Sie die API-Dokumentation für unterstützte Filter. Die Antwort liefert eine Liste von Schlüsselpaaren: Simon.Id-Simon.ExtKey.

Sie können dann verwenden: location/read/{id} , wobei {id} Ihre Simon.ID ist.

Verwenden Sie die Methode location/readsync, wenn Sie Simon und Ihre eigenen Systeme mit einem Dienst synchronisieren möchten. Fügen Sie das letzte Änderungsdatum oder die zuletzt verwendete  Simon-ID ein, um eine Liste von  Simon-IDs nach diesem Datum oder dieser genauen ID zu erhalten.

Nutzungsbedingungen für die Simple-Simon API

Bei der Nutzung der Simple-Simon API gelten die folgenden Geschäftsbedingungen:

  • Zugriffsanfrage: Um Zugang zu erhalten, senden Sie eine E-Mail an support@simple-simon.net mit der Bitte um API-Aktivierung. Wir werden sicherstellen, dass Ihre Umgebung entsprechend für die API-Nutzung konfiguriert ist.
  • Aktive Lizenz erforderlich: Sie müssen mindestens eine aktive (bezahlte) Simple-Simon Lizenz besitzen, um die API zu nutzen. Leider ist der API-Zugriff während der Testphase nicht verfügbar.
  • Auf eigenes Risiko: Jegliche Störungen Ihrer Simple-Simon-Umgebung, ERP-Integration oder Kalender-Einrichtung, die durch die API-Nutzung verursacht werden, erfolgen vollständig auf eigenes Risiko.
  • Supportkosten: Sollten Sie Unterstützung von unserem IT-Team benötigen, wird der Support mit 1.200 € pro Manntag berechnet, mit einer Mindestgebühr von einem vollen Manntag.

Optimieren Sie Ihren Workflow mit der Simple-Simon API

Integrieren Sie Simple-Simon nahtlos in Ihre bestehenden Geschäftssysteme und verbessern Sie die Effizienz auf ganzer Linie!