{"id":9787,"date":"2024-10-01T08:09:35","date_gmt":"2024-10-01T08:09:35","guid":{"rendered":"https:\/\/simple-simon.com\/integration\/make-your-own-integration\/"},"modified":"2025-12-29T13:15:02","modified_gmt":"2025-12-29T13:15:02","slug":"make-your-own-integration","status":"publish","type":"integration","link":"https:\/\/simple-simon.com\/en\/integrations\/make-your-own-integration\/","title":{"rendered":"Make your own integration"},"content":{"rendered":"\n\n\n
\n\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t\t\t\t\"\"\n\t\t\t\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t

Get Started with the Simple-Simon API Integration<\/h1>\n

Protect your data and optimise your workflows with the Simple-Simon API. Follow these best practices for a secure and efficient implementation.<\/p>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t<\/div>\n\n\t\t<\/div>\n\n\n\t<\/div>\n<\/section>\n\t

\n\t\t
\n\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\"\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t

Key Restrictions for Using the Simple-Simon API:<\/h2>\n

– 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.
\n– API access request: Submit a one-time request to Simon Support to activate API access. You\u2019ll receive an email containing a URL and full documentation for each available method.
\n– Your responsibility: You are solely responsible for protecting your API credentials from unauthorised access and for maintaining the integrity and quality of your data.
\n– Costs: The first three months of API usage are free. After that, the service costs \u20ac395 per year.<\/p>\n\n\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t<\/div>\n\t\t<\/div>\n\t<\/section>\n\t

\n\t\t
\n\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\"\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t

Create your own integration<\/h2>\n

To build your own custom integration with Simple-Simon, you\u2019ll need the following:
\n1. Simon Licence Code: A 16-digit Simon licence key.
\n2. Simon Office Username: For example, the email address used in your request.
\n3. Password: The password associated with this user account.
\n4. One-Time Request: API access must be requested once to activate the integration.<\/p>\n

Support Details:
\nSimple-Simon\u2019s REST server supports HTTP GET\/POST methods, SOAP is not supported. The REST API is available in English only, and all table names are also in English.<\/p>\n\n\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t<\/div>\n\t\t<\/div>\n\t<\/section>\n\t

\n\t\t
\n\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\"\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t

Key Tables in the Simple-Simon API<\/h2>\n

– Customer: Represents a customer. A customer can have one or more associated work locations.
\n– Location: The job or work address linked to a work order. A location can also exist without being linked to a customer.
\n– WorkOrder: The actual work order. Every work order is always linked to a location.
\n– ItemGroup: A group of items or materials, used for organising inventory.
\n– Item: Individual articles or materials within an item group.
\n– User: Represents both office staff and field workers.
\n– Planning: Always contains a link between a work order and a user (for scheduling).
\n– WorkOrderSurvey: Digital forms or checklists created in Simon, linked to a specific work order.
\n– UsedItem: Materials used or consumed on a work order.
\n– TimeSheet: Travel and working hours associated with a work order.
\n– Workorder\/DigitalPresentation: The digital work order exported as a PDF.
\n– WorkOrderSurvey\/DigitalPresentation: The completed survey or checklist exported as a PDF.<\/p>\n\n\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t<\/div>\n\t\t<\/div>\n\t<\/section>\n\t

\n\t\t
\n\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\"\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t

General<\/h2>\n

To authenticate with the Simple-Simon API (Restserver), you must first retrieve an access token using the following credentials:
\nKey: Your 16-digit Simple-Simon license code
\nPwd: Your user password
\nUsr: Your Simon username<\/p>\n

Upon successful authentication, you will receive a token that is required for all subsequent API requests. This token has an expiration time. Make sure to refresh it regularly to maintain uninterrupted access during your session. For detailed instructions, refer to the HELP section on the login endpoint of Simon\u2019s Restserver.<\/p>\n\n\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t<\/div>\n\t\t<\/div>\n\t<\/section>\n\t

\n\t\t
\n\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\"\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t

Methodology Simons<\/h2>\n

The Simon Restserver follows a consistent and uniform structure across all tables. The following example using the location table (representing a job site or work address) applies similarly to other available tables.<\/p>\n

You can perform the following operations on work addresses:<\/p>\n

location\/insert<\/em><\/p>\n

location\/update<\/em><\/p>\n

location\/delete<\/em><\/p>\n

For update and delete operations, you are required to provide the Simon.Id<\/em>. Simon always uses two identifiers: The automatically created Simon-ID\u00a0<\/em>and your own key\/ID named\u00a0ExtKey<\/em>.<\/p>\n

ExtKey<\/em> may be left empty or have a unique value<\/p>\n

To find a Simon.ID for a specific location, you use location\/read<\/em>.\u00a0You can supply filter parameters to narrow down the results. Refer to the API documentation for supported filters. The response will return a list of key pairs: Simon.Id \u2013 Simon.ExtKey.<\/em><\/p>\n

You can then use: location\/read\/{id}, where {id}<\/em> your Simon.ID is.<\/p>\n

Use the method\u00a0location\/read\/{id}\u00a0<\/em>if you’d want to sync Simon and your own systems with a service. Insert the last mutation date or last used Simon-ID to receive a list of Simon-ID’s after that date or that exact ID.<\/p>\n\n\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t<\/div>\n\t\t<\/div>\n\t<\/section>\n\t

\n\t\t
\n\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\"\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t

Terms of Use for the Simple-Simon API<\/h2>\n

When using the Simple-Simon API, the following terms and conditions apply:
\n– Access Request: To gain access, send an email to support@simple-simon.net<\/a> requesting API activation. We will ensure your environment is configured appropriately for API usage.
\n-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.
\n– 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.
\n– Support Costs: Should you require assistance from our IT team, support is charged at \u20ac1,200 per man-day, with a minimum charge of one full man-day.<\/p>\n

Optimise your workflow with the Simple-Simon API
\nSeamlessly integrate Simple-Simon with your existing business systems and improve efficiency across the board!<\/p>\n\n\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t<\/div>\n\t\t<\/div>\n\t<\/section>","protected":false},"excerpt":{"rendered":"","protected":false},"featured_media":10833,"parent":0,"template":"","class_list":["post-9787","integration","type-integration","status-publish","has-post-thumbnail","hentry","integration_category-australia","integration_category-belgie-en","integration_category-canada","integration_category-denmark","integration_category-duitsland-en","integration_category-finland","integration_category-france","integration_category-ireland","integration_category-nederland-en","integration_category-new-zeeland","integration_category-norway","integration_category-oostenrijk-en","integration_category-south-africa","integration_category-sweden","integration_category-united-kingdom","integration_category-united-states","integration_category-zwitserland-en"],"acf":[],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/simple-simon.com\/en\/wp-json\/wp\/v2\/integration\/9787","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/simple-simon.com\/en\/wp-json\/wp\/v2\/integration"}],"about":[{"href":"https:\/\/simple-simon.com\/en\/wp-json\/wp\/v2\/types\/integration"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/simple-simon.com\/en\/wp-json\/wp\/v2\/media\/10833"}],"wp:attachment":[{"href":"https:\/\/simple-simon.com\/en\/wp-json\/wp\/v2\/media?parent=9787"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}