SaaSquatch Help Center

The Referral SaaSquatch REST API is authenticated by providing one of your API keys in the request.

Authenticating your API calls allows SaaSquatch to confirm that the data and instructions we receive genuinely came from you, protecting your program from unauthorized actions or data. This is done using a code, your API Key, that should only be known to you and our system. Do not expose this API key to unauthorized users, such as through code of a client-side page.

If a call is made to us that doesn't include the correct corresponding API Key, it will be rejected. You authenticate to the Referral SaaSquatch API by providing one of your API keys in the request. You can manage your API keys from the install page of your Referral SaaSquatch portal account. Your API keys carry many privileges, so be sure to keep them secret!

Note: Your program has both a Live and Test tenant, which each have their own API key. Make sure you are using the correct key for the tenant you are using.

Authentication to the API occurs via HTTP Basic Auth. Provide your API key as the basic auth password. You do not need to provide a username.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. You must authenticate for all requests.

🔗 Example:

curl -X POST https://app.referralsaasquatch.com/api/v1/{tenant_alias}/code/{code} \
-u :TEST_B4BYA15POHYQ284HBND1 \

curl uses the -u flag to pass basic auth credentials.

In this Article:
- [Example:](#example-)