Docs are being personalised for new programs
SaaSquatch Help Center

API Keys

The SaaSquatch APIs authenticate requests using API Keys to ensure secure data transmission.

All interactions with the SaaSquatch API use an API key for authentication.

🔗 Access API key

Access the API key of either your Live and Test tenant.

  1. Sign in to the SaaSquatch Admin Portal.
  2. Choose your live or test tenant from the tenant selection dropdown.
  3. Go to Settings > General.
  4. In the Tenant details section, click the eye icon to reveal the API key.
  5. Click "Reveal" to display the API key.

Note: 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.

Do not expose any API keys to unauthorized users, such as through code of a client-side page.

🔗 Reset API Key

If an API key has been compromised, It can be reset to ensure secure exchanges of data.

  1. Sign in to the SaaSquatch Admin Portal.
  2. Choose your live or test tenant from the tenant selection dropdown.
  3. Go to Settings > General.
  4. In the Tenant details section, click Reset below the API key heading.
  5. Click Reset on the confirmation message. Click "Reset" under the API Key section.

A new API key is now available for the Tenant.

All API requests are made over HTTPS. Unsecured requests will fail.

🔗 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.