Meta
Calls are made to https://api.footer365.net with an API key as a bearer token. This page is generated from the API's own description, which you can download.
GET
/v1/health
Check the service is up
Needs no key. Says only that the service is answering.
Answers 200 with HealthReply.
GET
/v1/me
Describes the caller's key
The organisation, reseller or distributor the key acts for, the key's name and prefix, the scopes it holds, the rate limits it is held to, and the part of the organisation it is limited to when its maker was limited to one. Needs any valid key.
Answers 200 with MeReply.
Types
HealthReply
| Property | Type | About it |
|---|---|---|
status |
string | ok. |
MeReply
| Property | Type | About it |
|---|---|---|
principal |
string | Whose key it is: organisation, reseller or distributor. |
organisation |
MeOrganisation | The organisation, reseller or distributor it acts for; a reseller's has no domain. |
key |
MeKey | The key, by name and prefix. |
scopes |
array of string | The scopes it holds. |
rateLimits |
MeRateLimits | The calls it may make a minute. |
limitedTo |
string, or null | Gets the name of the part of the organisation the key is limited to, when it was made by an administrator limited to one; null when it reaches the whole organisation. |
MeOrganisation
| Property | Type | About it |
|---|---|---|
id |
string (uuid) | Its Footer365 id. |
name |
string | Its name. |
domain |
string | Its primary domain. |
MeKey
| Property | Type | About it |
|---|---|---|
name |
string | What it is for. |
prefix |
string | The start of the key, which is not secret. |
MeRateLimits
| Property | Type | About it |
|---|---|---|
readsPerMinute |
integer | Reads. |
writesPerMinute |
integer | Changes. |
Errors are written the same way for every call; see Errors. Answers may gain fields within a version, so ignore any you do not recognise.