Introduction

Hi. Welcome. More text here soon(tm)

API Key

In order to interact with the API you need an API key. You can get one by donating any amount on Patreon. You will receive more info once the subscription is passed. For service partners, please see below.

Please make sure to keep your API key secret. If you accidentally share your key with others (by pushing it on a public git repository for instance), please renew your key immediately. This can be done in the dashboard right next to where your current API key can be found.

Public API

To authorize, use the Authorization header in your API requests. The value of which should be:

Basic <api_key>
Example:
Basic ABCDEFGHIJKLMNOPQRSTUVWXYZ

Partner API

The Partner API is only accessible to FreeStuff partners. If you got access through donating, all partner only features (also referred to as "restricted access endpoints") will not be available.

To authorize, use the Authorization header in your API requests. The value of which should be:

Partner <api_key> <service_uid>
Example:
Partner ABCDEFGHIJKLMNOPQRSTUVWXYZ 1