API Open Endpoints
Open Endpoints are API Calls designed for simplified use of the SaaSquatch REST API functionality in client applications like the Mobile widget and SDK.
🔗 Use Cases
The primary use case for the Open Endpoints is in client-server interactions such as through a mobile app. These actions typically involve looking up information about a referred user or who referred them.
Some examples include:
- Lookup a referral code after app install to display a dialog about who referred them
- Register a new user in the referral program
- Lookup share links to display a custom sharing dialog
- Lookup referrals to display a list of referred friends
🔗 Authentication Options
The Open Enpoints provide flexible authentication options:
- Authenticated - For Open Endpoint calls that reqire authentication there are two options:
- JWT - JWTs can be used for requests that require authentication.
- API Key - Your tenant's API key can also be used for requests that require authentication.
- Unauthenticated - Some Open Endpoints do not require any form of authentication.
🔗 Authentication Requirements by Method
The following table summarizes the Open Endpoint methods that are available for use, and their required level of authentication:
|Open Endpoint method||Authentication required|
|Create a user||Requires Write Token or API key|
|Upsert a user||Requires Write Token or API key|
|Lookup a user||Requires Read Token or API key|
|Lookup a user by referral code||No authentication required.|
|Lookup a referral code||No authentication required.|
|Apply a referral code||Requires Write Token or API key.|
|List referrals||Requires Read Token or API key.|
🔗 Authentication with JWT
Authentication with JWTs should be used in client-server, not server-server communication.
The SaaSquatch API accepts two types of JWTs: read tokens and write tokens. Read tokens are intended to validate a request to lookup information about an existing user/account while write tokens are intended to be used when adding or updating information about a user/account.
The format of the JWT payloads required for read and write tokens are outlined below:
|Read Token Payload||Write Token Payload|
The payload of a read token is based on the
The payload of a write token can contain the complete user object:
🔗 Building the JWT
The process for building the JWT is outlined on our JSON Web Tokens page.
Make sure you that you are trying to sign the correct format of the payload (Read Token vs Write Token) for your specific Open Endpoint API call.
🔗 Authentication with API Key
Authentication with your API key should be done when conducting server-server communication.
Authenticating Open Endpoint calls with an API key is done in the same way as with our standard API calls, details for which can be found in API Authentication.