Difference between revisions of "JSON API (SmartConnect)"
From SmartWiki
Michael Reid (talk | contribs) |
Michael Reid (talk | contribs) |
||
| Line 1: | Line 1: | ||
| + | == Introduction == | ||
| + | |||
SmartSimple’s SmartConnect JSON API provides a relatively easy to use method of integrating SmartSimple information with other web services and other programs. | SmartSimple’s SmartConnect JSON API provides a relatively easy to use method of integrating SmartSimple information with other web services and other programs. | ||
| − | The API uses industry standard JSON syntax and constructs. If you are not familiar with JSON you should take a look at the following tutorial before venturing much further in this topic: [ | + | The API uses industry '''standard JSON syntax and constructs'''. If you are not familiar with JSON you should take a look at the following tutorial before venturing much further in this topic: [http://www.w3schools.com/json/default.asp] |
| + | |||
| + | == General Overview of the API == | ||
| + | |||
| + | In order to use the API you will take the following steps: | ||
| + | |||
| + | * Within your instance of SmartSimple you will create one or more API functions that can be called through the API. | ||
| + | |||
| + | * Each function you create is linked to a specific SmartSimple object such as Organization, Contact, Report, Universal Tracking Application Level 1 object, Level 2 and level 3. | ||
| + | |||
| + | * Each function let's you restrict the fields that can be retrieved from that object. This approach ensures that you never expose data to the API that you don't want people to use in the API. | ||
| + | |||
| + | * You choose the Action that you wish to use for the function. Currently there are five action types: | ||
| + | ** Get - Retrieve a single record for the object type you have selected in the function. | ||
| + | ** List - Retrieve multiple records or the object type you have selected in the function. | ||
| + | ** Update - Change data in one or more fields in the object you have retrieved. | ||
| + | ** Download File - Downloads to the browser a file you have retrieved. | ||
| + | ** List Files - Retrieves a list of files from a specified object. | ||
| + | Each function used an Action Type to | ||
| − | + | * Each function generates a key that is unique to that function in that instance. So there is no possibility that the function can be without the key. | |
| − | |||
Revision as of 12:56, 9 December 2015
Introduction
SmartSimple’s SmartConnect JSON API provides a relatively easy to use method of integrating SmartSimple information with other web services and other programs.
The API uses industry standard JSON syntax and constructs. If you are not familiar with JSON you should take a look at the following tutorial before venturing much further in this topic: [1]
General Overview of the API
In order to use the API you will take the following steps:
- Within your instance of SmartSimple you will create one or more API functions that can be called through the API.
- Each function you create is linked to a specific SmartSimple object such as Organization, Contact, Report, Universal Tracking Application Level 1 object, Level 2 and level 3.
- Each function let's you restrict the fields that can be retrieved from that object. This approach ensures that you never expose data to the API that you don't want people to use in the API.
- You choose the Action that you wish to use for the function. Currently there are five action types:
- Get - Retrieve a single record for the object type you have selected in the function.
- List - Retrieve multiple records or the object type you have selected in the function.
- Update - Change data in one or more fields in the object you have retrieved.
- Download File - Downloads to the browser a file you have retrieved.
- List Files - Retrieves a list of files from a specified object.
Each function used an Action Type to
- Each function generates a key that is unique to that function in that instance. So there is no possibility that the function can be without the key.
