diff --git a/content/api/index.md b/content/api/index.md index c33900a5..03e3914e 100644 --- a/content/api/index.md +++ b/content/api/index.md @@ -5,19 +5,18 @@ slug: api sectionType: apiReference template: article.html hero: true -date: '2019-11-18' +date: "2019-11-18" --- - ### About the REST API The SaaSquatch REST API is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients. [JSON](http://www.json.org/) will be returned in all responses from the API, including errors. ### REST API Benefits -The SaaSquatch REST API provides a powerful, highly flexible, and highly customizable way of connecting your application with SaaSquatch. +The SaaSquatch REST API provides a powerful, highly flexible, and highly customizable way of connecting your application with SaaSquatch. -With the SaaSquatch API you can tailor your referral program to fit the specifics of your product and business model. +With the SaaSquatch API you can tailor your referral program to fit the specifics of your product and business model. ### Using the SaaSquatch REST API @@ -32,16 +31,37 @@ Each API method in the reference includes a full list of the available arguments -A full list of available API methods can be found in the SaaSquatch [REST API Reference](/api/methods) document. +A full list of available API methods can be found in the SaaSquatch [REST API Reference](/api/methods) document. The following examples are just some of what is possible through our REST API: -- [Create](/api/methods/#account_sync), [update](/api/methods/#account_sync), and [lookup](/api/methods/#get_account) Accounts -- [Create](/api/methods/#create_user), [update](/api/methods/#create_user), and [lookup](/api/methods/#get_user) Users -- [Attribute](/api/methods/#account_sync), [lookup](/api/methods/#get_referral), [list](/api/methods/#list_referrals), and [moderate](/api/methods/#moderate_referrals) referrals -- [Create](/api/methods/#create_reward), [List balance](/api/methods/#list_balances), and [redeem](/api/methods/#debit_balance) rewards +