General notes

The purpose of the Loyalty Service is to provide points, tiers and ranking info.

Authentication

Access to the API is granted by a valid key, which is provided by the Fans United team and appended to each request via the ?key=Example123Key attribute. However, this authentication will only give you access to the API. The data in the API is sensitive, so you need to use additional, personal Bearer token to authenticate. The token can be acquired via the Firebase SDKs and is valid for 60 minutes. You can use the standard OAuth2 protocol to refresh your token.

Quotas and Caching

Each request that hits our servers is counted to your quota, based on the key you use. For instance, if you make 5 requests to fetch the same user profile in a few minutes, we will only count the first request, since the others will be returned by the CDN directly. If a user requests their own profile 5 times, this will result in 5 requests being counted, since we do not cache that endpoint. So pay attention to the caching times.