Changes

{{Banner-UnderConstruction}}

=Overview=

SmartSimple's SmartConnect API provides a relatively easy to use method of integrating SmartSimple information with other web services and systems. It is a RESTful API and loosely follows the principles of REST integration.

==Interactive Demonstration Page==

For a demo of how the API works, you can test some sample functions on our [https://api.smartsimple.com/devtools/dev_api.html interactive demonstration page]. This page is connected to a specific demonstration instance containing sample data. We strongly encourage you to review this page in order to gain a better understanding of the syntax and functionality of the API.

=Prerequisites=

* This API is only available for SmartSimple environments on the November 2015 release or later. We recommend you upgrade to the latest available release for the most up to date API functionality.

=Configuration - Essentials=

==Initial Setup==

You will need an active SmartSimple user account in order to make any API calls. There are two modes of operation for this API, and if you are planning on making remote calls you will first need to create and activate an API type user.

* '''Active session''': Where a user is already logged into SmartSimple with an active session and makes an API call from their web browser, e.g. an AJAX call. The user's existing session is used to authenticate the API call.

==Function Definition==

In order to use the API, you must first define the set of functions you wish to make available within SmartSimple. This is an added layer of security that lets you limit the available functions as well as field sets that you wish to expose through the API.

===Field List Syntax===

The ''Field List'' option within the function configuration is used to define which fields are retrievable through the function call. This is a free form text box in which you will need to construct your field list with the following syntax:

{| class="wikitable"

|-

|-

|-

|-

|}

==Usage==

===Posting Endpoints===

To make an API call you will need to post to the appropriate endpoint which will simply be based on the ''Object Type'' of the API function. The general endpoint will be in the form of:

{| class="wikitable"

|-

|-

|-

|-

|-

|-

|-

|-

|-

|}

===Message Body===

* '''url''': The URL to post to.

* '''apitoken''': The unique ID generated and associated to each SmartConnect function.

If you are making a remote call from an external system you will also need to include:

* '''username''': The email address of an active API type user account.

* '''password''': The corresponding password to the above user account.

==Update Behaviour==

* Any existing and applicable template formulas will be triggered and run after a record update.

* Any existing and applicable workflows will be triggered and run after a record update.

=Configuration - Advanced=

=Appendix=

==Options and Settings==

<!--Explain all applicable misc options and settings that shouldn't be explained above here...-->

===Available Object Types===

{| class="wikitable"

|-

|-

|-

|-

|-

|}

===Available Action Types===

The following is a full list of available actions. Please note that not all actions will be available for all object types.

{| class="wikitable"

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|}

=Examples=

<!--

-->

[[Category:Integration]][[Category:API]][[Category:SmartConnect RESTful API]]