Aan de slag met Simple-Simon API-integratie

Bescherm je data en optimaliseer je processen met de Simple-Simon API. Volg deze richtlijnen voor een veilige en efficiënte toepassing.

Belangrijkste restricties:

  • Actieve licentie vereist: de gebruikersnaam en wachtwoord moeten gekoppeld zijn aan een actieve licentie voor de huidige maand. Dit hoeft geen extra gebruiker te zijn.
  • API-toegang aanvragen: dien een eenmalig verzoek in bij Simon Support om de API te activeren. Je ontvangt een e-mail met een URL-link en documentatie voor elke methode.
  • Verantwoordelijkheid: jij bent verantwoordelijk voor het beschermen tegen ongeautoriseerd gebruik en het waarborgen van de integriteit en kwaliteit van je data.
  • Kosten: de eerste drie maanden zijn gratis. Daarna bedragen de kosten €495 per jaar.

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.

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.

Voorwaarden voor het Gebruik van de Simple-Simon API

Wanneer je de Simple-Simon API wilt gebruiken, gelden de volgende voorwaarden:

  • Aanvraag indienen: stuur een bericht naar support met het verzoek om toegang. Wij zorgen ervoor dat je omgeving geschikt wordt gemaakt voor het gebruik van onze API’s.
  • Actieve licentie: je moet minimaal één actieve (betaalde) licentie hebben om de API te gebruiken. Tijdens de proefperiode is gebruik van de Simple-Simon API helaas niet mogelijk.
  • Eigen risico: het verstoren van je eigen Simple-Simon omgeving, de integratie met je ERP-systeem en/of je agenda door gebruik van de API is op eigen risico.
  • Ondersteuningskosten: als je ondersteuning van ons IT-team nodig hebt, bedragen de kosten €1.200 per mandag, met een minimale afname van één mandag.

Optimaliseer je workflow met de Simple-Simon API en integreer moeiteloos met je bestaande systemen!