Skip to content

index.md

Latest commit

 

History

History
44 lines (31 loc) · 2.62 KB

index.md

File metadata and controls

44 lines (31 loc) · 2.62 KB
Raw
title REST API
highlights Our REST API lets you build your own custom logic on top of your referral program. The [API reference](/api/methods) includes details about using all the methods of the SaaSquatch REST API.
slug api
sectionType apiReference
template article.html
hero true

About the REST API

The SaaSquatch REST API is organized around REST. 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 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.

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

Each API method in the reference includes a full list of the available arguments (both required and optional), and exmaple cURL request, details of the structure of the response, and a complete example of the JSON response.

**API Endpoint** https://app.referralsaasquatch.com/api/v1/

A full list of available API methods can be found in the SaaSquatch REST API Reference document.

The following examples are just some of what is possible through our REST API:

**Note:** Please be aware that the SaaSquatch API is not currently supported when making use of one of our direct payment provider integrations. However, it is still possible to connect up your referral program to your payment provider through your existing business flow with the use of our API. Please check out one of our many guides to get stated setting up your referral program.