Getting started
Authentication
No route needs a key. A key raises your limit above the free one, to what was agreed for it.
Sending a key
Put it in either header; both do the same:
curl "https://isleswiki.net/api/v1/items" \
-H "Authorization: Bearer iwk_YOUR_KEY"
curl "https://isleswiki.net/api/v1/items" \
-H "X-API-Key: iwk_YOUR_KEY"Key format
A key is iwk_ and 32 letters, digits, - and _. Only a fingerprint of it is kept, so a lost key cannot be looked up again: ask for a new one.
Keep it on a server
Getting a key
Keys are made by hand: ask the wiki's owner on Discord and say what you are building and about how many calls a minute it needs. Without a key you have 60 calls a minute per address, which is plenty for most uses.
When a key is refused
- 401
bad_keyThe key is unknown or was revoked. It is refused rather than quietly treated as no key, so you notice. Leave it out to use the free limit. - 429
rate_limitedThe key's own limit is used up for now; the answer says when to try again.
A revoked key stops working at once. The upload route is the exception to all this: it takes the sync service's upload token, not an API key.