Get Started with the Simple-Simon API Integration

Protect your data and optimise your workflows with the Simple-Simon API. Follow these best practices for a secure and efficient implementation.

Key Restrictions for Using the Simple-Simon API:

  • Active licence required: The username and password used must be linked to an active licence for the current month. This does not have to be an additional user account.
  • API access request: Submit a one-time request to Simon Support to activate API access. You’ll receive an email containing a URL and full documentation for each available method.
  • Your responsibility: You are solely responsible for protecting your API credentials from unauthorised access and for maintaining the integrity and quality of your data.
  • Costs: The first three months of API usage are free. After that, the service costs €495 per year.

Create your own integration

To build your own custom integration with Simple-Simon, you’ll need the following:
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.

Support Details:
Simple-Simon’s API server supports HTTP GET/POST/PUT/DELETE methods and ODATA protocols, SOAP is not supported. The API is available in English only, and all entity names are also in English.

Key Entities in the Simple-Simon API

  • 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.

General

To authenticate with the Simple-Simon API, you must first obtain an access token by calling the login endpoint with the following credentials:

  • 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)

Upon successful authentication, you will receive a bearer token that must be included as a header parameter in all subsequent API requests. This token has an expiration time, once expired request a new one again by calling the login endpoint again to avoid interruptions during your session. For full details on the login endpoint, request/response format, and all available operations, refer to the interactive API documentation received via Email.

Methodology Simons

The Simple Simon API follows a consistent and uniform structure across all entities. The following example using the location table (representing a job site or work address) applies similarly to other available entities.
You can perform the ODATA operations on work addresses:

  • 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.

You can supply filter parameters to narrow down the results, ODATA filtering can be applied to all the properties available. To gain more knowledge on how ODATA filtering works, click here.

For update and delete operations, you are required to provide the Id. Refer to the API documentation for supported filters.

Terms of Use for the Simple-Simon API

When using the Simple-Simon API, the following terms and conditions apply:

  • Access Request: To gain access, send a message to support requesting API activation. We will ensure your environment is configured appropriately for API usage.
  • Active Licence Required: You must have at least one active (paid) Simple-Simon licence to use the API. Unfortunately, API access is not available during the trial period.
  • At Your Own Risk: Any disruptions caused to your Simple-Simon environment, ERP integration, or calendar setup through API usage are entirely at your own risk.
  • Support Costs: Should you require assistance from our IT team, support is charged at €1,200 per man-day, with a minimum charge of one full man-day.

Optimise your workflow with the Simple-Simon API
Seamlessly integrate Simple-Simon with your existing business systems and improve efficiency across the board!