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.

Two business colleagues have a discussion in the office, focused on the laptop screen, brainstorming.

Wichtigste Einschränkungen:

  • Aktive Lizenz erforderlich: Benutzername und Passwort müssen mit einer aktiven Lizenz für den laufenden Monat verknüpft sein. Dies muss kein zusätzlicher Benutzer sein.
  • API-Zugang beantragen: Stelle eine einmalige Anfrage beim Simon Support, um die API zu aktivieren. Du erhältst eine E-Mail mit einem URL-Link und der Dokumentation zu jeder Methode.
  • Verantwortung: Du bist dafür verantwortlich, deine Daten vor unbefugter Nutzung zu schützen und ihre Integrität und Qualität sicherzustellen.
  • Kosten: Die Kosten betragen €495 pro Jahr.

Eigene Integration erstellen

Um deine eigene Integration umzusetzen, benötigst du Folgendes:

  1. Simon-Lizenzcode: ein 16-stelliger Simon-Lizenzschlüssel.
  2. Simon-Office-Benutzername: zum Beispiel die E-Mail-Adresse, die du bei deiner Anfrage verwendet hast.
  3. Passwort: das Passwort, das zu diesem Benutzerkonto gehört.
  4. Einmalige Anfrage: Der API-Zugang muss einmalig beantragt werden, um die Integration zu aktivieren.
  5. API-Schlüssel: Du erhältst ihn per E-Mail nach deiner einmaligen Anfrage.

Weitere Details:
Der API-Server von Simple-Simon unterstützt die HTTP-Methoden GET, POST, PUT und DELETE sowie das OData-Protokoll. SOAP wird nicht unterstützt. Die API ist ausschließlich auf Englisch verfügbar, und auch alle Entitätsnamen sind englischsprachig.

Own Integration Icon

Wichtigste Tabellen

  • Customer: Stellt einen Kunden dar. Ein Kunde kann einen oder mehrere zugehörige Einsatzorte haben.
  • Contact: Eine Kontaktperson, die mit einem Kunden oder einem Einsatzort verknüpft ist.
  • Location: Die Einsatz- oder Arbeitsadresse, die mit einem Arbeitsauftrag verknüpft ist. Ein Einsatzort kann auch ohne Verknüpfung mit einem Kunden bestehen.
  • WorkOrder: Der eigentliche Arbeitsauftrag. Jeder Arbeitsauftrag ist immer mit einem Einsatzort verknüpft.
  • Equipment: Anlagen oder Installationen, die an einem Einsatzort erfasst und mit Arbeitsaufträgen verknüpft sind.
  • ItemGroup: Eine Gruppe von Artikeln oder Materialien zur Organisation des Bestands.
  • Item: Einzelne Artikel oder Materialien innerhalb einer Artikelgruppe.
  • User: Steht sowohl für Büromitarbeitende als auch für Außendienstmitarbeitende.
  • Planning: Enthält immer eine Verknüpfung zwischen einem Arbeitsauftrag und einem Benutzer (für die Einsatzplanung).
  • WorkOrderSurvey: Digitale Formulare oder Checklisten, die in Simon erstellt und mit einem bestimmten Arbeitsauftrag verknüpft werden.
  • UsedItem: Materialien, die bei einem Arbeitsauftrag verwendet oder verbraucht wurden.
  • TimeSheet: Fahrt- und Arbeitszeiten, die zu einem Arbeitsauftrag gehören.
  • Attachment: Dateien oder Fotos, die an einen Arbeitsauftrag, einen Einsatzort oder einen Kunden angehängt sind.

Allgemein

Um dich bei der Simple-Simon API zu authentifizieren, musst du zunächst ein Zugriffstoken anfordern. Dazu rufst du den Login-Endpunkt mit den folgenden Anmeldedaten auf:

  • lickey: dein 16-stelliger Simple-Simon-Lizenzcode
  • apiKey: den du per E-Mail erhalten hast
  • password: dein Benutzerpasswort
  • username: dein Simon-Benutzername (z. B. die E-Mail-Adresse, die mit deinem Konto verknüpft ist)

Nach erfolgreicher Authentifizierung erhältst du ein Bearer-Token, das du in allen weiteren API-Anfragen als Header-Parameter mitsenden musst. Dieses Token hat eine Ablaufzeit. Sobald es abgelaufen ist, forderst du ein neues Token an, indem du den Login-Endpunkt erneut aufrufst. So vermeidest du Unterbrechungen während deiner Sitzung. Alle Details zum Login-Endpunkt, zum Format von Anfragen und Antworten sowie zu allen verfügbaren Operationen findest du in der interaktiven API-Dokumentation, die du per E-Mail erhalten hast.

Methodik von Simon

Die Simple-Simon API folgt für alle Entitäten einer konsistenten und einheitlichen Struktur. Das folgende Beispiel verwendet die Tabelle „Location“, die eine Baustelle oder Arbeitsadresse darstellt. Es gilt in gleicher Weise für alle anderen verfügbaren Entitäten.
Du kannst die folgenden OData-Operationen auf Arbeitsadressen ausführen:

  • POST: /locations : zum Anlegen eines neuen Einsatzorts
  • PUT: /locations/{id} : zum Aktualisieren eines bestimmten Einsatzorts anhand der ID
  • DELETE: /locations/{id} : zum Löschen eines bestimmten Einsatzorts anhand der ID
  • GET: /locations/{id} : zum Abrufen eines bestimmten Einsatzorts anhand der ID
  • GET: /locations : zum Abrufen einer Liste von Einsatzorten

Mit Filterparametern kannst du die Ergebnisse eingrenzen. OData-Filter lassen sich auf alle verfügbaren Eigenschaften anwenden. Klicke hier, um mehr darüber zu erfahren, wie OData-Filter funktionieren.

Für Operationen wie Aktualisieren und Löschen musst du die ID angeben. Welche Filter unterstützt werden, findest du in der API-Dokumentation.

tevreden buitendienst

Voraussetzungen für die Nutzung der Simple-Simon API

Wenn du die Simple-Simon API nutzen möchtest, gelten die folgenden Voraussetzungen:

  • Anfrage stellen: Sende eine Nachricht an den Support mit der Bitte um Zugang. Wir sorgen dafür, dass deine Umgebung für die Nutzung unserer APIs eingerichtet wird.
  • Aktive Lizenz: Du benötigst mindestens eine aktive (kostenpflichtige) Lizenz, um die API zu nutzen. Während des Testzeitraums ist die Nutzung der Simple-Simon API leider nicht möglich.
  • Eigenes Risiko: Störungen deiner eigenen Simple-Simon-Umgebung, der Integration mit deinem ERP-System und/oder deines Kalenders durch die Nutzung der API erfolgen auf eigenes Risiko.
  • Supportkosten: Wenn du Unterstützung durch unser IT-Team benötigst, betragen die Kosten 1.300 € pro Personentag, bei einer Mindestabnahme von einem Personentag.
  • Jährliche Abrechnung: Die API-Kosten werden einmal jährlich im Voraus in Rechnung gestellt. Nach Eingang deiner Zahlung sorgen wir dafür, dass dein API-Zugang aktiviert wird.

Optimiere deinen Workflow mit der Simple-Simon API und integriere sie mühelos in deine bestehenden Systeme!