MyFreestone® API Documentation
At its core, the MyFreestone® API allows registered users to access and modify their MyFreestone® data. Using basic HTTP requests, you can make calls to our RESTful API and retrieve, update, add, or delete items in your MyFreestone® dataset. This allows you to integrate the best features of MyFreestone® into your own applications!
Note: While our API aims to be intuitive to use, developers should still have a good understanding of HTTP request methods and REST services before making requests that update or delete data.
API Overview
The Freestone® API supports four request methods that follow the basic CRUD model:
- POST – Creates data
- GET – Retrieves data
- PUT – Updates data
- DELETE – Deletes data
Basic Tutorial
The following are brief examples of how each HTTP request method works with our API. Although we accept JSON or XML requests, for the sake of brevity our examples will demonstrate access using the command-line tool cURL and JSON parameters.
GET Request
# Retrieve resource 123 from the sample endpoint
curl -u USERNAME:KEY -X GET https://api.myfreestone.com/sample/123
POST Request
# Create a new resource of sample type, with the supplied parameters
curl -u USERNAME:KEY -X POST -d '{"field":"value"}' https://api.myfreestone.com/sample
PUT Request
# Update resource 123 at the sample endpoint with the supplied parameters
curl -u USERNAME:KEY -X PUT -d '{"field":"new value"}' https://api.myfreestone.com/sample/123
DELETE Request
# Delete resource 123 from the sample endpoint
curl -u USERNAME:KEY -X DELETE https://api.myfreestone.com/sample/123