Changes

SmartConnect - RESTful API

35 bytes added, 21:35, 22 June 2018
no edit summary
This API uses industry standard JSON syntax and constructs. If you are not familiar with JSON you should take a look at the [https://www.w3schools.com/js/js_json_intro.asp following tutorial] before venturing much further in this topic.
 
==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=
==Usage==
 
Make sure [[Creating JSON functions|JSON API functions]] were created in the instance before you can use them.
* The update functions are also used to create new records. This can be done by setting the recordid to 0. The response will then display the recordid of the record created.
=== ===
===Posting Endpoints===
To make an API call you will need to post to the appropriate endpoint which will simply be based on the ''Record Type'' of the API function. The general endpoint will be in the form of:
Here is a more detailed look at [[Using JSON functions|using SmartConnect functions]].
 
* If updating, ensure the recordid is correct
* Review the post endpoint url is pointing to the correct resource
 
|}
=SmartConnect Examples=See our [https://api.smartsimple.com/devtools/dev_api.html interactive demonstration page] for a demo and live sample of how the API works. 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.  See [[API Sample Code|API examples]] for a sample list of SmartConnect calls.  
<!--
0
edits