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.

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 495 € pro Jahr.

Eigen koppeling maken

Om je eigen koppeling te realiseren, heb je het volgende nodig:
1. Simon Licence Code: A 16-digit Simon licence key.
2. Simon Office Username: For example, the email address used in your request.
3. Password: The password associated with this user account.
4. One-Time Request: API access must be requested once to activate the integration.
5. Api Key: Received via the email upon the One-Time Request.

Ondersteunende details:
De Simple-Simon’s API server ondersteund HTTP GET/POST/PUT/DELETE methodes en ODATA protocols, SOAP wordt niet ondersteund. De API is uitsluitend beschikbaar in het Engels en alle entiteitsnamen zijn eveneens Engelstalig.

Own Integration Icon

Belangrijkste tabellen

  • Customer: Represents a customer. A customer can have one or more associated work locations.
  • Contact: A contact person linked to a customer or location.
  • Location: The job or work address linked to a work order. A location can also exist without being linked to a customer.
  • WorkOrder: The actual job sheet. Every work order is always linked to a location.
  • Equipment: Assets or installations registered at a location, linked to job sheets.
  • ItemGroup: A group of items or materials, used for organising inventory.
  • Item: Individual articles or materials within an item group.
  • User: Represents both office staff and field workers.
  • Planning: Always contains a link between a job sheet and a user (for scheduling).
  • WorkOrderSurvey: Digital forms or checklists created in Simon, linked to a specific job sheet.
  • UsedItem: Materials used or consumed on a job sheet.
  • TimeSheet: Travel and working hours associated with a job sheet.
  • Attachment: Files or photos attached to a job sheet, location, or customer.

Algemeen

Om je bij de Simple-Simon API te authenticeren, moet je eerst een toegangstoken aanvragen door het login-eindpunt aan te roepen met de volgende inloggegevens:

  • lickey: Your 16-digit Simple-Simon licence code
  • apiKey: Received via Email,
  • password: Your user password,
  • username: Your Simon username (e.g. the email address linked to your account)

Na succesvolle authenticatie ontvang je een bearer-token dat in alle volgende API-verzoeken als headerparameter moet worden opgenomen. Dit token heeft een vervaltijd. Zodra het is verlopen, dien je een nieuw token aan te vragen door het inlog-eindpunt opnieuw aan te roepen, om onderbrekingen tijdens uw sessie te voorkomen. Raadpleeg de interactieve API-documentatie die je via e-mail hebt ontvangen voor alle details over het inlog-eindpunt, het formaat van verzoeken en antwoorden, en alle beschikbare bewerkingen.

Methodiek
Simons

De Simple Simon API volgt voor alle entiteiten een consistente en uniforme structuur. Het volgende voorbeeld, waarin de locatietabel (die een bouwplaats of werkadres vertegenwoordigt) wordt gebruikt, geldt op dezelfde manier voor andere beschikbare entiteiten.
Je kunt de ODATA-bewerkingen uitvoeren op werkadressen:

  • POST: /locations : for inserting new location
  • PUT: /locations/{id} : for updating a particular location with Id
  • DELETE: /locations/{id} : for deleting a particular location with Id
  • GET: /locations/{id} : for fetching a particular location with Id
  • GET: /locations: for fetching list of locations.

Je kunt filterparameters opgeven om de resultaten te verfijnen; ODATA-filtering kan worden toegepast op alle beschikbare eigenschappen. Klik hier voor meer informatie over hoe ODATA-filtering werkt.

Voor bewerkingen zoals bijwerken en verwijderen moet je de ID opgeven. Raadpleeg de API-documentatie voor de ondersteunde filters.

tevreden buitendienst

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.300 € 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!